Les API de module sont utilisées pour servir les fonctionnalités du système et peuvent être regroupées dans les catégories suivantes :

Fonctionnalités générales

topologie

Carte

Propriétés

Paramètres réseau

Device Group

site

Interrogation de table intégrée

Vue des données

Variable d'entrée

Fonctionnalités générales

API

Description

AddMessage(message, niveau_message[, nom_table_associée, index_ligne_de_table_associée])

Imprimer un message.

message — le texte du message.

message_level — le niveau du message. La valeur par défaut est MessageLevel.InformationMessageLevel.Information.

nom_table_associée — le nom de la table associée. La valeur par défaut est nulle.

row_index_of _associated_table (entier) — spécifiez un numéro de ligne de la table associée. La valeur par défaut est 0.

AddDeviceAlert (nom_appareil, nom_alerte, alerte, niveau_alerte)

Imprimez un message d'alerte de périphérique dans la console d'événements.

device_name — le nom de l'appareil.

alert_name — le nom du texte de l'alerte (cette API est conservée et doit être étendue).

alert — le texte de l'alerte.

alert_level — le niveau de l'alerte, tel que AlertLevel.Error ou AlertLevel.Warning.

AddInterfaceAlert (nom_appareil, nom_interface, nom_alerte, alerte, niveau_alerte)

Imprimer un message d'alerte d'interface dans la console d'événements.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

alert_name — le nom du texte d'alerte le nom du texte d'alerte (cette API est conservée et doit être étendue).

alert — le texte de l'alerte.

alert_level — le niveau de l'alerte, tel que AlertLevel.Error ou AlertLevel.Warning.

CompleteInterfaceName (nom_appareil, nom_interface)

Renvoie un nom d'interface complet en recherchant le table de traduction des noms d'interface selon le type d'appareil correspondant de l'appareil et le nom de l'interface.

GetInterfaceShortName(nom_périphérique, nom_interface)

Renvoie le nom abrégé d'une interface en fonction du type d'appareil correspondant au nom de l'appareil et de l'interface.

GetInterface(nom_périphérique, nom_interface, type_interface)

Renvoie un objet d'interface.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — les types d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

GetInterfacesByType (type_interface)

Renvoie toutes les interfaces qui appartiennent à un type d'interface spécifié. Le type de données renvoyé est list.

interface_type — les types d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

topologie

API

Description

GetDevicesByMedia(nom_média, type_média, type_topologie)

Renvoie les appareils connectés à un média spécifique. Le type de données renvoyé est list.

media_name — le segment LAN ou WAN auquel les interfaces se connectent en commun.

media_type — le type de média des interfaces, comme 100BaseTX.

topology_type — les types de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

GetInterfacesByMedia(nom_média, type_média, type_topologie)

Renvoie les appareils connectés à un média spécifique. Le type de données renvoyé est list.

media_name — le segment LAN ou WAN auquel les appareils se connectent en commun.

media_type — le type de média des interfaces, comme 100BaseTX.

topology_type — les types de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

GetDevice(nom_device)

Renvoie un objet périphérique. Si le périphérique est introuvable, renvoyez Aucun.

device_name — le nom de l'appareil.

GetInterface(nom_périphérique, nom_interface, type_interface)

Renvoie un objet d'interface.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — les types d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

GetInterfacesByDevice(nom_device)

Renvoie les interfaces d'un périphérique spécifié. Le type de données renvoyé est list.

device_name — le nom de l'appareil.

GetNeighborsOfDevice(nom_périphérique[, type_topologie])

Renvoie les voisins d'un appareil. Le type de données renvoyé est list.

device_name — le nom de l'appareil.

topology_type — la valeur par défaut du type de topologie est null, ce qui fait référence à tous les types de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

GetNeighborInterfacesOfDevice(nom_périphérique[, type_topologie])

Renvoie les interfaces voisines d'un périphérique. Le type de données renvoyé est list.

device_name — le nom de l'appareil.

topology_type — la valeur par défaut du type de topologie est null, ce qui fait référence à tous les types de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

GetNeighborsOfInterface(nom_périphérique, nom_interface, type_interface[, type_topologie])

Renvoie les périphériques voisins d'une interface. Le type de données renvoyé est list.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — les types d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

topology_type — le type de topologie. La valeur par défaut est null, qui fait référence à tous les types de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

GetNeighborInterfacesOfInterface(nom_périphérique, nom_interface, type_interface[, type_topologie])

Renvoie les interfaces voisines d'une interface. Le type de données renvoyé est une liste.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — les types d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

topology_type — le type de topologie. La valeur par défaut est null, qui fait référence à tous les types de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

AddPhantomInterface(nom_périphérique, nom_interface, type_interface, appartient_au_type_topologie)

Ajoutez une interface fantôme.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — les types d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

Appartient_à_topologie_type — le type de topologie auquel l'interface fantôme appartient. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

GetMememberBelong2Channel (nom_appareil, nom_interface_appareil)

Renvoie la liste des interfaces membres d'une interface agrégée et les objets de la liste sont des interfaces membres de l'interface agrégée. Si l'interface agrégée n'existe pas, la liste renvoyée est vide.

device_name — le nom de l'appareil.

device_interface_name — le nom de l'interface agrégée.

Carte

API

Description

MapAutoLayout ([style_de_disposition, nom_de_la_carte, nom_de_la_page])

Spécifiez le style de mise en page d'une carte.

layout_style — le style de mise en page de la carte. Par défaut, la valeur est LayoutStyle.Symmetric. Voir Style de mise en page automatique pour plus de détails.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

MapAutoLink([type_topologie, nom_carte, nom_page])

Liez automatiquement les appareils sur une page de carte.

topology_type — Spécifiez pour utiliser le type de topologie à connecter. La valeur par défaut est la topologie IPv4 L3. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawDevice(device_name[, auto_link, topology_type, map_name, page_name])

Dessinez un appareil sur une carte.

device_name — le nom de l'appareil.

auto_link — le type de valeur est bool et la valeur par défaut est oui, ce qui signifie que le lien automatique est activé.

Topology_type — spécifiez à utiliser quel type de topologie. La valeur par défaut est la topologie IPv4 L3. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawInterface (nom_appareil, nom_interface, type_interface, type_topologie[, nom_carte, nom_page])

Dessinez les interfaces spécifiées d'un appareil sur une carte.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — le type d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

Topology_type — le type de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawInterfaceNeighbor(nom_périphérique, nom_interface, type_interface, type_topologie, nom_périphérique_voisin[, nom_carte, nom_page])

Dessinez l'interface spécifiée et son périphérique voisin sur une carte.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — le type d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

Topology_type — le type de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

nom_device_voisin — le nom du périphérique voisin.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawEndSystem(adresse[, nom_périphérique_connecté, nom_interface_connectée, type_interface, type_topologie, nom_carte, nom_page])

Dessinez un système final sur une carte.

adresse — l'adresse IP ou MAC du système final.

connected_device_name — le nom d'hôte de l'appareil auquel le système final se connecte.

connected_interface_name — le nom de l'interface à laquelle le système final se connecte.

interface_type — le type de l'interface à laquelle le système final se connecte. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec.

ogreVpnIntfs — Interface VPN GRE.

topology_type — le type de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawMapNote(title, content[, note_type, expand, forecolor, font_size, align, background_color, map_name, page_name])

Dessinez une note sur une carte.

titre — le titre du contenu de la note.

contenu — le contenu de la note

note_type — le type d'affichage d'une carte. Le type par défaut est notetype.append. Voir type de note pour plus de détails.

développer — s'il faut développer le contenu de la note. Le type de valeur est bool et la valeur par défaut est Faux.

forecolor — la couleur de la police du texte de la note.

font_size — la taille de la police du texte de la note.

align — le style d'alignement du texte de la note. La valeur par défaut est la couleur noire. Voir alignement pour plus de détails.

background_color — la couleur de fond de la note. La valeur par défaut est Couleur.RGB(255, 255, 128).

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawDeviceNote(device_name, title, content[, note_type, expand, forecolor, font_size, align, background_color, map_name, page_name])

Dessinez une note attachée à l'appareil spécifié sur une carte.

device_name — le nom de l'appareil.

titre — le titre du contenu de la note.

contenu — le contenu de la note.

note_type — le type d'affichage d'une carte. Le type par défaut est notetype.append. Voir type de note pour plus de détails.

Développer — s'il faut développer le contenu de la note. Le type de valeur est bool et la valeur par défaut est Faux.

forecolor — la couleur de la police du texte de la note.

font_size — la taille de la police du texte de la note.

align — le style d'alignement du texte de la note. La valeur par défaut est la couleur noire. Voir alignement pour plus de détails.

background_color — la couleur de fond de la note. La valeur par défaut est Couleur.RGB(255, 255, 128).

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawInterfaceNote(device_name, interface_name, interface_type topology_type, title, content[, note_type, expand, forecolor, font_size, align, background_color, map_name, page_name])

Dessinez une note attachée à une interface d'un appareil sur une carte.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — le type de l'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec

Topology_type — le type de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

titre — le titre du contenu de la note.

note_type — le type d'affichage d'une carte. Le type par défaut est notetype.append. Voir type de note pour plus de détails.

Développer — s'il faut développer le contenu de la note. Le type de valeur est bool et la valeur par défaut est non.

forecolor — la couleur de la police du texte de la note.

font_size — la taille de la police du texte de la note.

align — le style d'alignement du texte de la note. La valeur par défaut est la couleur noire. Voir alignement pour plus de détails.

background_color — la couleur de fond de la note. La valeur par défaut est Couleur.RGB(255, 255, 128).

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawHyperLink(texte, url[, nom_carte, nom_page])

Dessinez un lien hypertexte sur une carte.

text — le texte d'affichage du lien hypertexte

url — l'adresse du lien hypertexte.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawTraceRouteHops([{'ips' :[]}])

Dessinez le résultat du traceroute saut par saut sur une carte basée sur l'adresse IP de chaque saut. Le paramètre de cette API est une liste de sauts séquentielle et vous devez saisir tous les sauts en fonction de la séquence dans laquelle un saut est dessiné.

ips — L'adresse IP d'un saut. Saisissez toutes les adresses IP d'équilibrage de charge dans le champ ips si un saut contient un équilibrage de charge. Par exemple, 'ips':["IP2","IP3"], IP2 et IP3 sont des sauts d'équilibrage de charge.

HighlightDevice(device_name, legend[, color, append, map_name, page_name])

Mettez en surbrillance l'appareil spécifié sur une carte.

device_name — le nom de l'appareil.

légende — le nom de la légende.

color — la couleur de l'appareil en surbrillance. La valeur par défaut est couleur aléatoire.

append — ajoute la couleur de surbrillance et affiche plusieurs couleurs à la fois. Le type de valeur est bool et la valeur par défaut est oui.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

HighlightInterface(device_name, interface_name, interface_type, topology_type, legend[, color, line_style, width, append, map_name, page_name])

Mettez en surbrillance l'interface spécifiée sur une carte.

device_name — le nom de l'appareil.

interface_name — le nom de l'interface.

interface_type — le type d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec

Topology_type — le type de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

légende — le nom de la légende.

color — la couleur de l'interface en surbrillance. La valeur par défaut est Couleur. Aléatoire. Voir couleur pour plus de détails.

ajouter — décider d'ajouter ou non la couleur de surbrillance et d'afficher plusieurs couleurs à la fois. Le type de valeur est bool et la valeur par défaut est oui.

width — la largeur du lien.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

HighlightNeighbor(source_device_name, destination_device_name, légende, source_text, destination_text[, couleur, two_way, line_style, épaisseur, map_name, page_name])

Mettez en surbrillance le voisin spécifié d'un appareil sur une carte.

source_device_name — le nom d'hôte du périphérique source.

destination_device_name — le nom d'hôte du périphérique voisin.

légende — le nom de la légende.

source_text — toutes les chaînes concernant le périphérique source.

destination_text — toutes les chaînes concernant le périphérique voisin.

color — la couleur de l'interface en surbrillance. La valeur par défaut est la couleur. Aléatoire. Voir couleur pour plus de détails.

two_way - s'il faut tracer une ligne avec deux directions. Le type de valeur est bool et la valeur par défaut est non.

line_style — le style de la ligne. Voir style de ligne pour plus de détails.

épaisseur — l'épaisseur du lien. La valeur par défaut est 2.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

DrawHop(nom_appareil1, nom_appareil2[, texte, couleur, type_ligne, épaisseur, nom_carte, nom_page])

Déposez une ligne pointant vers le saut suivant d'un appareil sur une carte.

device_name1 — le nom d'hôte du périphérique source.

device_name2 — le nom d'hôte du prochain périphérique de saut.

texte — un texte affiché sur le prochain périphérique de saut. La valeur par défaut est nulle.

color — la couleur de la ligne menant au prochain périphérique de saut. La valeur par défaut est La couleur rouge.

line_style — le style de la ligne. Voir style de ligne pour plus de détails.

épaisseur — l'épaisseur du lien. La valeur par défaut est 2.

map_name — le nom d'une carte. La valeur par défaut est null, ce qui signifie que la carte sur laquelle le Qapp actuel s'exécute.

page_name — le nom de la page de la carte. La valeur par défaut est null, ce qui signifie que la page de la carte sur laquelle le Qapp actuel s'exécute.

GetAllVisibleDevices

Retourne tous les appareils sur une carte. Le type de données renvoyé est list.

ObtenirTouteslesInterfacesVisibles

Renvoie toutes les interfaces visibles d'un périphérique spécifié sur une carte. Le type de données renvoyé est list.

device_name — le nom d'hôte du périphérique spécifié.

Propriétés

API

Description

SetDeviceProperty (nom_propriété, nom_appareil, valeur)

Définissez une valeur pour une propriété spécifiée d'un périphérique.

nom_propriété — le nom de la propriété de périphérique spécifiée, telle que la version du logiciel.

device_name — le nom d'hôte du périphérique spécifié.

valeur — la valeur de la propriété.

GetDeviceProperty (nom_propriété, nom_appareil)

Renvoie la valeur d'une propriété de périphérique spécifiée.

nom_propriété — le nom de la propriété de périphérique spécifiée, telle que la version du logiciel.

device_name — le nom d'hôte du périphérique spécifié.

SetModuleProperty (nom_propriété, nom_appareil, nom_module, valeur)

Définissez une valeur pour une propriété de module spécifiée d'un périphérique.

nom_propriété — le nom de la propriété de module spécifiée, comme SW Rev.

device_name — le nom d'hôte du périphérique spécifié.

module_name — le nom du module.

value — la valeur de la propriété du module.

GetModuleProperty (nom_propriété, nom_appareil, nom_module)

Renvoie la valeur d'une propriété de module spécifiée.

nom_propriété — le nom de la propriété de module spécifiée, comme SW Rev.

device_name — le nom d'hôte du périphérique spécifié.

module_name — le nom du module.

SetInterfaceProperty (nom_propriété, nom_appareil, nom_interface, type_interface, valeur)

Définissez une valeur pour une propriété d'interface spécifiée d'un périphérique.

nom_propriété — le nom de la propriété d'interface spécifiée, comme SW Rev.

device_name — le nom d'hôte du périphérique spécifié.

interface_name — le nom de l'interface.

interface_type — le type de l'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec

value — la valeur de la propriété du module.

GetInterfaceProperty (nom_propriété, nom_appareil, nom_interface, type_interface)

Renvoie la valeur d'une propriété d'interface spécifiée d'un périphérique.

nom_propriété — le nom de la propriété de module spécifiée, comme SW Rev.

device_name — le nom d'hôte du périphérique spécifié.

interface_name — le nom de l'interface.

interface_type — le type de l'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec

SetSiteProperty (nom_propriété, chemin_site, valeur)

Définissez une valeur pour la propriété spécifiée d'un site.

nom_propriété — le nom de la propriété de site spécifiée, telle que Région.

site_path — le chemin complet du site, tel que Mon Réseau\Site A.

valeur — la valeur de la propriété du site.

GetSiteProperty (nom_propriété, chemin_site)

Renvoie la valeur de la propriété de site spécifiée.

nom_propriété — le nom de la propriété de site spécifiée, telle que Région.

site_path — le chemin complet du site, tel que Mon Réseau\Site A.

Paramètres réseau

API

Description

SetDeviceCredential(nom_appareil, nom d'utilisateur, mot de passe, nom d'utilisateur privilège, mot de passe_privilège[, mode_accès, port])

Définissez les identifiants de connexion pour un appareil.

device_name — le nom d'hôte du périphérique.

nom d'utilisateur — le nom d'utilisateur pour se connecter à l'appareil.

mot de passe — le mot de passe pour se connecter à l'appareil.

privilege_username — le nom d'utilisateur pour accéder au mode privilégié de l'appareil.

privilege_password — le mot de passe pour accéder au mode privilégié de l'appareil.

access_mode — le mode d'accès, tel que Telnet, SSH.

port — le port du mode d'accès, tel que 23.

Device Group

API

Description

CreateDeviceGroup (nom_groupe_device, type_groupe_appareil)

Créer un device group.

device_group_name — le nom du device group.

device_group_type — le type du device group, comme Public.

AddDeviceToDeviceGroup (nom_appareil, nom_groupe_appareil)

Ajouter un appareil dans un device group.

device_group_name — le nom du device group.

device_name — le nom de l'appareil.

RemoveDeviceFromDeviceGroup (nom_appareil, nom_groupe_appareil)

Supprimer un appareil d'un device group.

device_group_name — le nom du device group.

device_name — le nom de l'appareil.

ClearDevicesInDeviceGroup (nom_groupe_device)

Effacer les appareils dans un device group.

device_group_name — le nom du device group.

GetDevicesFromDeviceGroup(nom_groupe_device)

Renvoyer tous les appareils dans un device group. Le type d'objet renvoyé est list.

device_group_name — le nom du device group.

site

API

Description

GetSitePathOfDevice(nom_device))

Renvoie le chemin complet du site qui contient le périphérique spécifié.

device_name — le nom de l'appareil.

GetSiteNameOfDevice(nom_device)

Renvoie le nom du site qui contient le périphérique spécifié.

device_name — le nom de l'appareil.

GetDevicesFromSite(site_path[, include_child])

Renvoie tous les appareils d'un site. Le type d'objet renvoyé est list.

site_path — le chemin complet du site, tel que Mon réseau\Site A.

include_child — le type de valeur est bool et la valeur par défaut est non, ce qui signifie que la valeur renvoyée n'inclut pas les appareils des sites enfants du site.

Interrogation de table intégrée

API

Description

Rechercher un fournisseur par Mac (adresse_mac)

Renvoie les informations du fournisseur sur un périphérique par adresse MAC.

mac_address — l'adresse MAC du périphérique.

Vue des données

API

Description

AddDeviceDataUnit (nom_appareil, nom_élément, type_élément, valeur)

Ajoutez une unité de données pour un appareil pour l'affichage des données.

device_name — le nom de l'appareil.

item_name — le nom de l'unité de données, comme la version.

item_type — le type de l'unité de données, comme string et int.

valeur — la valeur de l'unité de données.

AddInterfaceDataUnit (nom_device, nom_interface, type_interface, type_topologie, nom_élément, type_élément, valeur)

Ajoutez une unité de données pour une interface spécifiée d'un appareil pour l'affichage des données.

device_name — le nom de l'appareil.

Nom_interface — le nom de l'interface.

Interface_type — le type d'interface. Le type d'interface comprend :

ointfs — interface physique.

oipIntfs — Interface IPv4.

oip6Intfs — Interface IPv6.

oipsecVpnIntfs — Interface VPN IPsec

Topology_type — le type de topologie. Le type de topologie comprend :

oL2_Topo_Type — Topologie de la couche 2.

oL3_Topo_Type — Topologie de couche 4 IPv3.

oIpv6_L3_Topo_Type — Topologie IPv6 L3.

oVPN_Topo_Type — Topologie du tunnel VPN L3.

item_name — le nom de l'unité de données, tel que mtu.

item_type — le type de l'unité de données, comme string et int.

valeur — la valeur de l'unité de données.

Variable d'entrée

API

Description

ListDir (chemin_absolu)

Renvoie les fichiers et sous-dossiers contenus dans un dossier spécifié.

chemin_absolu — le chemin absolu du dossier.

ReadFile (chemin_absolu)

Renvoyer le contenu d'un fichier

chemin_absolu — le chemin absolu du fichier.

IsFolder (chemin_absolu)

Déterminez si le chemin du dossier est valide. Si valide, renvoie True, sinon renvoie false.

chemin_absolu — le chemin absolu du dossier.

EstFichier (chemin_absolu)

Déterminez si le chemin du fichier est valide. Si valide, renvoie True, sinon renvoie false.

chemin_absolu — le chemin absolu du fichier.

Existe (chemin_absolu)

Évaluer si le chemin absolu d'un fichier ou d'un dossier existe. s'il existe, renvoie True, sinon renvoie false.

chemin_absolu — le chemin absolu du fichier ou du dossier.

 

Voir aussi:

Types d'interfaces

Propriétés de l'interface

Propriété du module

Unité de données

Types de topologie

Device Group