Extraction des disques partagés (v2)

Disponible à partir de la version 9.2.12. Vous pouvez utiliser l'opération GET sur l'élément api/sam/v2/shared_disks pour demander des informations sur les disques partagés utilisés dans votre infrastructure.

Prérequis

Pour pouvoir extraire des informations sur des disques partagés à l'aide de l'API REST, reconnaissez les disques partagés de votre infrastructure. Pour plus d'informations, voir : étape 1 : Reconnaissance des disques partagés distants.

Droits

Utilisateur Vous devez disposer des droits Afficher les disques partagés pour utiliser cette API.

URL de la ressource

https://hostname:port/api/sam/v2/shared_disks?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 Shared Disks element
Format de réponse application/json
Codes de réponse

200 – OK

403 – “Forbidden” si l'utilisateur n'est pas autorisé à exécuter l'action

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/shared_disk.json?token=<token>

Colonnes disponibles

Tableau 2. Colonnes disponibles
Colonne Description Affichée par défaut Type
id Identificateur de l'instance de disque partagé. ✓ éntier
status Indique le statut de l'ordinateur désigné pour l'instance de disque de partage. Les valeurs possibles sont :
  • 0 - Disque partagé détecté
  • 1 - Disque partagé enfant
  • 2 - Désignation d'un ordinateur
  • 3 - En attente de l'analyse de logiciels
  • 4 - OK
  • 5 - Désignation d'un nouveau répertoire de niveau supérieur
  • 6 - Désignation d'un nouvel ordinateur
  • 7 - En attente de l'analyse de logiciels sur l'ordinateur nouvellement désigné
 ✓ éntier
parent_id Identificateur du parent de l'instance de disque partagé. ✓ éntier
top_level Indique si le disque partagé est un répertoire de niveau supérieur dans la structure du disque partagé. Les valeurs possibles sont :
  • 0 - Le répertoire n'est pas un répertoire de niveau supérieur
  • 1 - Le répertoire est un répertoire de niveau supérieur
 Valeur boléenne
exported_directory Répertoire exporté du disque partagé. ✓ Chaîne
type Type de disque partagé. Les valeurs possibles sont :
  • 0 - Système de fichiers réseau
  • 1- Système de fichiers Samba
 ✓ éntier
computers_count Nombre d'ordinateurs sur lesquels le disque partagé est monté. ✓ éntier

Associations applicables

Vous pouvez par ailleurs extraire des données des associations suivantes :

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 : extraction du nom et de la version du produit
URL?columns[]=product_name&columns[]=product_release
 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
 Alphanumérique
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
 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-number> | <json-null>

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

Exemple : éxtrayez des instances logicielles dont le nom de produit contient "BigFix" OU dont la date de début de la reconnaissance se trouve dans une plage de dates spécifiques 
URL?criteria={ "or": [ ["product_name", "contains", "BigFix"], 
{ "and": [ ["discovery_start", ">", "1970-01-01T00:00:00+00:00Z"], 
["discovery_start", "<", "1970-01-02T00:00:00+00:00Z"] ] } ] }

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.

Exemple : extraction des instances de logiciel signalées pour la première fois au cours des sept derniers jours
URL?criteria={"and":[["discovery_start","last","P7D"]]}
 Chaîne

Exemple de conversation - Colonne par défaut

Demande
GET api/sam/v2/shared_disks?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Corps de la réponse
[{
"id":"5",
"status":"0"'
"type":"0"
"designated_computer_id":"29"
"parent_id":"3"
"computers_count":"10"
"exported_directory":"192.0.2.24:/file_server/tlcm/ISO/RHEL"

Exemple de conversation - Toutes les colonnes

Demande
GET api/sam/v2/shared_disks?columns[]=id&columns[]=status
&columns[]=parent_id&columns[]=top_level&columns[]=exported_directory
&columns[]=type&columns[]=computers_count&columns[]=designated_copmuter_id
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Corps de la réponse
[{
"id":"1",
"status":"0",
"parent_id":"5",
"top_level":"0",
"exported_directory":"192.0.2.24:/file_server/tlcm/HOME"
"type":"0",
"computers_count":"10",
"designated_computer_id":"29"

Exemple de conversation - Association

Demande
GET api/sam/v2/shared_disks?columns[]=exported_directory
&columns[]=computers_count&columns[]=shared_disk_members.computer_id
&columns[]=shared_disk_members.mount_point&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US
Corps de la réponse
[{
"exported_directory":"192.0.2.24:/file_server/tlcm/HOME",
"computers_count":"1",
"members":
    {
    "computer_id":"5",
    "mount_point":"/mnt/fs"
    }
}]