Extraction des informations relatives aux adaptateurs réseau (v2)

Disponible à partir de la version 9.2.12. Utilisez l'opération GET sur l'élément api/sam/v2/detailed_hw_network_adapters pour demander des informations relatives au type, au modèle et aux adresses Mac des adaptateurs réseau.

Droits

Utilisateur Vous devez disposer des droits Afficher les nœuds finaux et Afficher l'inventaire matériel pour utiliser cette API.

URL de la ressource

https://hostname:port/api/sam/v2/detailed_hw_network_adapters?token=token

Informations sur les ressources

Tableau 1. Informations sur les ressources
Détails de l'opération Description
Méthode HTTP GET
En-têtes de demande
Fonction métier
Accept-Language (Facultatif)
Valeurs
en-US (seul l'anglais est pris en charge)

Négocie la langue de la réponse. Si l'en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
Format de demande application/json
En-têtes de réponse
En-tête
Content-Type
Valeurs
application/json

Définit le type de contenu de la réponse.
En-tête
Content-Language
Valeurs
en-US, …

Définit la langue du contenu de la réponse. Si l'en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.
Charge de la réponse Network Adapter element
Format de réponse application/json
Codes de réponse

200 – OK

500 – "Bad Request" si un paramètre de requête contient des erreurs ou est manquant

Description de schéma

Pour extraire la liste de toutes les colonnes renvoyées par cette API REST, ainsi que leurs descriptions, utilisez la demande suivante :
GET api/sam/v2/schemas/detailed_hw_network_adapter.json?token=token

Colonnes disponibles

Liste des attributs liés aux adaptateurs réseau.

La sortie de l'analyse peut contenir plusieurs instances de chaque attribut de ce groupe.

Tableau 2. Colonnes contenant des informations sur les adaptateurs réseau
Property Description Type
id Identificateur de l'enregistrement. éntier
computer_id Identificateur de l'ordinateur tel qu'il est spécifié dans la base de données BigFix Inventory. éntier
updated_at Date et heure auxquelles les informations actuelles ont été importées vers BigFix Inventory. Chaîne
permanent_address Adresse MAC (Media Access Control) permanente associée à l'adaptateur. Chaîne
current_address Adresse réseau actuelle de l'adaptateur. Chaîne
type Type d'adaptateur réseau. Chaîne
model Modèle de l'adaptateur réseau. Chaîne

API associées

Cette API peut être associée à l'API suivante :

Paramètres de requête

Tableau 3. Paramètres de requête
Paramètre Description Requis Valeur
columns[] Indique les colonnes à extraire. Si vous n'indiquez pas ce paramètre, seules les colonnes par défaut sont extraites.
Exemple : éxtraire l'ID de l'ordinateur :
URL?columns[]=computer_id
 Chaîne
order Indiquez comment trier les données renvoyées. Le sens de tri par défaut des colonnes est croissant. Si vous souhaitez spécifier un tri par ordre décroissant, ajoutez desc au nom de la colonne.
Exemple : classement des ID ordinateur suivant l'ordre décroissant :
URL?order[]=computer_id desc
 Chaîne
limit Indiquez le nombre de lignes à extraire. Si vous omettez ce paramètre, toutes les lignes sont extraites.
Exemple : éxtraire 100 enregistrements 
URL?limit=100
Remarque : Par défaut, le paramètre limit pour cette API est défini sur 100000. 
 Numérique
décalage Indiquez le nombre de lignes à ignorer pour extraire les résultats. Vous pouvez l'utiliser en même temps que le paramètre de limite pour mettre en page les résultats.
Exemple : éxtrayez 50 enregistrements en commençant après l'enregistrement 150
URL?limit=50&offset=150
 Numérique
Jeton Identificateur d'authentification utilisateur unique. Vous pouvez l'extraire en utilisant l'API REST pour l'extraction du jeton d'authentification. Vous pouvez également vous connecter à BigFix Inventory, survoler l'icône Utilisateur Icône utilisateur et cliquer sur Profil. Cliquez ensuite sur Afficher le jeton. ✓ Alphanumérique
critères éxtrayez les enregistrements qui correspondent à des conditions spécifiques. Le paramètre doit avoir la structure suivante, écrite sur une seule ligne : 
<criteria> ::= <left-brace> <boolean-operator><colon> <left-bracket> 
<criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace>
<boolean-operator> ::= "and" | "or"
<criterion> ::= <criteria> | <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket>
<column> ::= <json-string>
<operator> ::= <json-string>
<value> ::= <json-array> | <json-string> | <json-numver> | <json-null>

Pour plus d'informations sur les opérateurs, voir : Connecteurs et opérateurs communs.

Exemple : extraction des ordinateurs dont l'ID d'ordinateur est supérieur à 1000.
URL?criteria={"and":[["computer_id", ">", "1000"]]}

Pour les colonnes qui utilisent les valeurs de date et d'heure, vous pouvez également récupérer les données sur une période au lieu d'une date spécifique. Pour ce faire, utilisez last ou next comme <operator>, puis spécifiez la valeur de temps selon la convention suivante : PxD/PxW/PxM/PxY, où x est un nombre compris entre 1 et 999 et D, W, M ou Y est un identificateur qui représente les jours, semaines, mois ou années, respectivement.

Chaîne

Exemple de conversation - Colonne par défaut

Demande
GET api/sam/v2/detailed_hw_network_adapters?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Corps de la réponse
[{
"id":13,
"computer_id":4,
"updated_at":"2018-05-28T01:22:16Z",
"permanent_address":"00:50:56:94:A1:39",
"current_address":"00:50:56:94:A1:39",
"type":"Ethernet Adapter",
"model":"vmxnet3 Ethernet Adapter"
}]

Exemple de conversation - Colonne sélectionnée

Demande 
GET api/sam/v2/detailed_hw_network_adapters?columns[]=id
&columns[]=id&columns[]=type&columns[]=model
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Corps de la réponse
[{
"id":13,
"type":"Ethernet Adapter",
"model":"vmxnet3 Ethernet Adapter"
}]