Intégrer Automox à Google SecOps

Ce document explique comment intégrer Automox à Google Security Operations (Google SecOps).

Version de l'intégration : 5.0

Paramètres d'intégration

Utilisez les paramètres suivants pour configurer l'intégration :

Nom à afficher du paramètre Type Valeur par défaut Obligatoire Description
Racine de l'API Chaîne https://#123;#123;api_root#125;#125; Oui Racine de l'API de l'instance Automox.
Clé API Mot de passe N/A Non Clé API de l'instance Automox.
Vérifier le protocole SSL Case à cocher Cochée Oui Si cette option est activée, elle vérifie que le certificat SSL de la connexion à Automox est valide.

Pour obtenir des instructions sur la configuration d'une intégration dans Google SecOps, consultez Configurer des intégrations.

Vous pourrez apporter des modifications ultérieurement, si nécessaire. Une fois que vous avez configuré une instance d'intégration, vous pouvez l'utiliser dans des playbooks. Pour savoir comment configurer et prendre en charge plusieurs instances, consultez Prise en charge de plusieurs instances.

Générer une clé API

Pour savoir comment générer une clé API, consultez l'étape Find your API key in the console (Trouver votre clé API dans la console) du document Newbie's Guide to Getting Started with Automox API (Guide du débutant pour commencer à utiliser l'API Automox).

Actions

Pour en savoir plus sur les actions, consultez Répondre aux actions en attente depuis Votre bureau et Effectuer une action manuelle.

Enrichir les entités

Enrichissez les entités à l'aide des informations d'Automox.

Paramètres

Nom du paramètre Type Valeur par défaut Obligatoire Description
Renvoyer des correctifs Case à cocher Cochée Non

Si elle est activée, l'action renvoie une liste des correctifs à mettre à jour sur la machine.

Remarque : L'action ne renvoie pas les correctifs qui ont été installés ni ceux qui ont été ignorés.
Nombre maximal de correctifs à renvoyer Integer 50 Non Spécifiez le nombre de correctifs à renvoyer. Si aucune valeur n'est fournie, l'action renvoie 50 correctifs.

Date d'exécution

Cette action s'applique aux entités suivantes :

  • Adresse IP
  • Nom d'hôte

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur Exemple
is_success Vrai/Faux is_success=False
Résultat JSON
{
    "id": 2263017,
    "agent_version": "1.41.125",
    "commands": [],
    "compatibility_checks": {
        "missing_wmi_integrity_check": false,
        "missing_powershell": false,
        "low_diskspace": false
    },
    "compliant": true,
    "connected": false,
    "create_time": "2022-10-24T09:14:12+0000",
    "custom_name": "",
    "deleted": false,
    "detail": {
        "IPS": [
            "192.0.2.176",
            "2001:db8:1:1:1:1:1:1"
        ],
        "UPDATE_SOURCE_CHECK": {
            "CONNECTED": "True",
            "ERROR": "Succeeded"
        },
        "MDM_SERVER": null,
        "FQDNS": [
            "DESKTOP-65M05SE.WORKGROUP"
        ],
        "RAM": "8589934592",
        "SECURE_TOKEN_ACCOUNT": null,
        "LAST_USER_LOGON": {
            "SRC": "DESKTOP-65M05SE",
            "USER": "DESKTOP-65M05SE\\Admin",
            "TIME": "10/24/2022 2:59:45 AM"
        },
        "VOLUME": [
            {
                "IS_SYSTEM_DISK": "True",
                "VOLUME": "C:",
                "FSTYPE": "NTFS",
                "LABEL": "Local Disk",
                "AVAIL": "63766056960",
                "FREE": "39201988608"
            }
        ],
        "DISTINGUISHED_NAME": "",
        "MODEL": "VMware7,1",
        "CPU": "Intel(R) Xeon(R) CPU E5-2698 v3 @ 2.30GHz",
        "MDM_PROFILE_INSTALLED": null,
        "VENDOR": "VMware, Inc.",
        "AUTO_UPDATE_OPTIONS": {
            "OPTIONS": "off",
            "ENABLED": "1"
        },
        "SERVICETAG": "No Asset Tag",
        "PS_VERSION": "5",
        "WSUS_CONFIG": {
            "WSUS_REACHABLE": "1",
            "WSUS_MANAGED": "0",
            "WSUS_SERVER": ""
        },
        "SERIAL": "VMware",
        "NICS": [
            {
                "VENDOR": "Intel(R) 82574L Gigabit Network Connection",
                "DEVICE": "Ethernet0",
                "TYPE": "enet",
                "MAC": "01:23:45:AB:CD:EF",
                "IPS": [
                    "172.30.201.176",
                    "2001:db8:1:1:1:1:1:1"
                ],
                "CONNECTED": true
            },
            {
                "IPS": [],
                "CONNECTED": false,
                "VENDOR": "WAN Miniport (IP)",
                "DEVICE": "",
                "TYPE": "enet",
                "MAC": "01:23:45:AB:CD:EF"
            },
            {
                "VENDOR": "WAN Miniport (IPv6)",
                "DEVICE": "",
                "TYPE": "enet",
                "MAC": "01:23:45:AB:CD:EF",
                "IPS": [],
                "CONNECTED": false
            },
            {
                "CONNECTED": false,
                "VENDOR": "WAN Miniport (Network Monitor)",
                "DEVICE": "",
                "TYPE": "enet",
                "MAC": "01:23:45:AB:CD:EF",
                "IPS": []
            }
        ],
        "WMI_INTEGRITY_CHECK": "True",
        "VERSION": "440BX Desktop Reference Platform",
        "DISKS": [
            {
                "TYPE": "VMware Virtual disk SCSI Disk Device",
                "SIZE": "64420392960"
            }
        ]
    },
    "display_name": "DESKTOP-65M05SE",
    "exception": false,
    "instance_id": "",
    "ip_addrs": [
        "192.0.2.139"
    ],
    "ip_addrs_private": [
        "192.0.2.176",
        "2001:db8:1:1:1:1:1:1"
    ],
    "is_compatible": true,
    "is_delayed_by_notification": false,
    "is_delayed_by_user": false,
    "last_disconnect_time": "2022-10-25T09:19:29+0000",
    "last_logged_in_user": "DESKTOP-65M05SE\\Admin",
    "last_process_time": "2022-10-25T08:19:24+0000",
    "last_refresh_time": "2022-10-25T08:23:48+0000",
    "last_scan_failed": false,
    "last_update_time": "2022-10-25T08:22:14+0000",
    "mdm": null,
    "name": "DESKTOP-65M05SE",
    "needs_attention": false,
    "needs_reboot": false,
    "next_patch_time": null,
    "notification_count": 0,
    "organization_id": 104513,
    "organizational_unit": "",
    "os_family": "Windows",
    "os_name": "10 Enterprise Evaluation",
    "os_version": "10.0.19043",
    "os_version_id": 4876,
    "patch_deferral_count": 0,
    "patches": 1,
    "pending": false,
    "pending_patches": 0,
    "policy_status": [
        {
            "id": 316123693,
            "organization_id": 104513,
            "policy_id": 245687,
            "server_id": 2263017,
            "policy_name": "Apply All Patches",
            "policy_type_name": "patch",
            "status": 1,
            "result": "{}",
            "create_time": "2022-10-25T08:23:48+0000",
            "will_reboot": false,
            "pending_count": 0,
            "next_remediation": null
        }
    ],
    "reboot_deferral_count": 0,
    "reboot_is_delayed_by_notification": false,
    "reboot_is_delayed_by_user": false,
    "reboot_notification_count": 0,
    "refresh_interval": 1440,
    "serial_number": "VMware",
    "server_group_id": 145150,
    "server_policies": [],
    "status": {
        "device_status": "not-ready",
        "agent_status": "disconnected",
        "policy_status": "compliant",
        "policy_statuses": [
            {
                "id": 245687,
                "compliant": true
            },
            {
                "id": 245688,
                "compliant": true
            }
        ]
    },
    "tags": [
        "Recently Added"
    ],
    "timezone": "UTC-0700",
    "total_count": 1,
    "uptime": "1872",
    "uuid": "UUID",
    "list_of_patches": [
        {
            "id": 2077952013,
            "server_id": 2263017,
            "package_id": 227229243,
            "software_id": 167943,
            "installed": true,
            "ignored": false,
            "group_ignored": false,
            "deferred_until": null,
            "group_deferred_until": null,
            "name": "example",
            "display_name": "MSXML 6.0 RTM Security Update  (925673)",
            "version": "103",
            "repo": "WindowsUpdate",
            "cves": [],
            "cve_score": "9.0",
            "agent_severity": "9.0",
            "severity": "critical",
            "package_version_id": 233355423,
            "os_name": "10 Enterprise Evaluation",
            "os_version": "10.0.19043",
            "os_version_id": 4876,
            "create_time": "2021-06-28T15:45:57+0000",
            "requires_reboot": true,
            "patch_classification_category_id": 8,
            "patch_scope": "important",
            "is_uninstallable": false,
            "secondary_id": null,
            "is_managed": true,
            "impact": 0,
            "organization_id": 104513
        }
    ]
}
Enrichissement d'entités
Nom du champ d'enrichissement Logique : quand les utiliser ?
id Lorsqu'il est disponible au format JSON
agent_version Lorsqu'il est disponible au format JSON
conforme Lorsqu'il est disponible au format JSON
connecté Lorsqu'il est disponible au format JSON
create_time Lorsqu'il est disponible au format JSON
custom_name Lorsqu'il est disponible au format JSON
ip_addrs_private Lorsqu'il est disponible au format JSON
last_disconnect_time Lorsqu'il est disponible au format JSON
last_logged_in_user Lorsqu'il est disponible au format JSON
last_update_time Lorsqu'il est disponible au format JSON
os Lorsqu'il est disponible au format JSON
pending_patches Lorsqu'il est disponible au format JSON
tags Lorsqu'il est disponible au format JSON
Mur des cas
Type de résultat Valeur / Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

Si des données sont disponibles pour une entité (is_success=true) : "Les entités suivantes ont été enrichies avec succès à l'aide des informations d'Automox : {entity.identifier}".

Si les données ne sont pas disponibles pour une entité (is_success=true) : "L'action n'a pas pu enrichir les entités suivantes à l'aide des informations d'Automox : {entity.identifier}"

Si les données ne sont pas disponibles pour toutes les entités (is_success=false) : "Aucune des entités fournies n'a été enrichie."

L'action doit échouer et arrêter l'exécution d'un playbook :

Si une erreur fatale est signalée (par exemple, des identifiants incorrects, une absence de connexion au serveur ou autre) : "Erreur lors de l'exécution de l'action "Enrichir les entités". Raison : {0}''.format(error.Stacktrace)

 Général
Tableau du mur des cas

Titre : {entity.identifier}

Colonnes :

  • Clé
  • Valeur
 Entité

Exécuter une commande sur l'appareil

Exécutez une commande sur le point de terminaison dans Automox.

Paramètres

Nom du paramètre Type Valeur par défaut Obligatoire Description
Commande LDD

Analyser l'appareil

Valeurs possibles :

  • Analyser l'appareil
  • Installer des correctifs spécifiques
  • Installer tous les correctifs disponibles
  • Redémarrer l'appareil
 Non

Spécifiez une commande à exécuter sur l'appareil.

Remarque : Si l'option "Installer des correctifs spécifiques" est sélectionnée, le paramètre "Noms des correctifs" est obligatoire.
Noms des correctifs CSV N/A Non Spécifiez une liste de correctifs à installer, séparés par une virgule.

Date d'exécution

Cette action s'applique aux entités suivantes :

  • Adresse IP
  • Nom d'hôte

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur Exemple
is_success Vrai/Faux is_success=False
Résultat JSON
{
    "id": 8527028217,
    "server_id": 2263017,
    "command_id": 164850699,
    "organization_id": 104513,
    "args": "ASD",
    "reboot": 0,
    "exec_time": "2022-10-25T08:02:43+0000",
    "response": [
        "0",
        "Installing MS updates: ASD\\r\\nCouldn't find update for ASD, skipping.\\r\\nNothing left to do",
        null
    ],
    "response_time": "2022-10-25T08:22:14+0000",
    "policy_id": null,
    "agent_command_type": 0,
    "command_type_name": "InstallUpdate"
}
{
    "reason": "Device is offline. Please check the connectivity."
}
Mur des cas
Type de résultat Valeur / Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

Si l'appareil est trouvé et connecté (is_success=true) : "La commande "{Command}" a été exécutée avec succès sur les entités suivantes dans Automox : {entity.identifier}. Veuillez vérifier le résultat JSON pour vous assurer que la commande a été exécutée correctement."

Si l'appareil est introuvable ou s'il est connecté pour une entité (is_success=true) : "L'action n'a pas pu exécuter la commande "{Command}" sur les entités suivantes dans Automox : {entity.identifier}. Veuillez vérifier l'orthographe et la connectivité."

Si l'appareil n'est pas trouvé ou s'il est connecté pour toutes les entités (is_success=false) : "Aucune commande n'a été exécutée sur les entités fournies. Veuillez vérifier l'orthographe et la connectivité."

L'action doit échouer et arrêter l'exécution d'un playbook :

Si une erreur fatale est signalée (par exemple, des identifiants incorrects, l'absence de connexion au serveur ou autre) : "Erreur lors de l'exécution de l'action "Exécuter la commande de l'appareil". Raison : {0}''.format(error.Stacktrace)

 Général

Exécuter la règle

Exécutez une règle dans Automox.

Paramètres

Nom du paramètre Type Valeur par défaut Obligatoire Description
Champ d'application de la résolution LDD

Tous les appareils

Valeurs possibles :

  • Entités uniquement
  • Tous les appareils
 Non

Spécifiez le champ d'application de la correction pour l'action.

Si l'option "Entités uniquement" est sélectionnée, l'action n'applique les règles qu'aux entités valides dans le champ d'application.

Si l'option "Tous les appareils" est sélectionnée, l'action applique la règle à tous les appareils de l'organisation.
Nom de la règle Chaîne N/A Non Spécifiez le nom de la règle à exécuter.

Date d'exécution

Cette action s'applique aux entités suivantes :

  • Adresse IP
  • Nom d'hôte

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur Exemple
is_success Vrai/Faux is_success=False
Résultat JSON
{
"status": "done/failure if entity not found"
}
Mur des cas
Type de résultat Valeur / Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

Si le serveur a été corrigé et que l'opération a réussi pour une entité (is_success=true) : "La règle {Policy} a bien été exécutée sur les entités suivantes dans Automox : {entity.identifier}."

Si le serveur a été corrigé et qu'un serveur est introuvable (is_success=true) : "L'action n'a pas pu exécuter la règle {Policy} sur les entités suivantes dans Automox : {entity.identifier}."

Si le serveur a été corrigé et qu'aucun serveur n'est trouvé (is_success=false) : "Aucune entité n'a été trouvée. La règle {Policy} n'a pas été exécutée."

Si la correction de tous les serveurs a réussi (is_success=true) : "La règle {Policy} a été exécutée avec succès dans Automox."

L'action doit échouer et arrêter l'exécution d'un playbook :

Si une erreur fatale est signalée (par exemple, des identifiants incorrects, une absence de connexion au serveur ou autre) : "Erreur lors de l'exécution de l'action "Exécuter la règle". Raison : {0}''.format(error.Stacktrace)

Si la règle est introuvable : "Erreur lors de l'exécution de l'action "Exécuter la règle". Motif : la règle "{nom de la règle}" n'a pas été trouvée dans Automox. Veuillez vérifier l'orthographe.""

Général

Répertorier les règles

Répertoriez les règles disponibles dans Automox.

Paramètres

Nom du paramètre Type Valeur par défaut Obligatoire Description
Clé de filtre LDD

Sélectionnez une réponse

Valeurs possibles :

  • Nom
  • ID
  • Nom du type de règle
  • État
 Non Spécifiez la clé à utiliser pour filtrer la règle.
Logique de filtrage LDD

Non spécifié

Valeurs possibles :

  • Non spécifié
  • Égal à
  • Contient
 Non

Spécifiez la logique de filtrage à appliquer.

La logique de filtrage fonctionne en fonction de la valeur fournie dans le paramètre "Clé de filtre".
Valeur du filtre Chaîne N/A Non

Spécifiez la valeur à utiliser dans le filtre.

Si l'option "Égal à" est sélectionnée, l'action tente de trouver la correspondance exacte parmi les résultats. Si l'option "Contient" est sélectionnée, l'action tente de trouver les résultats contenant cette sous-chaîne.

Si aucune valeur n'est fournie pour ce paramètre, le filtre n'est pas appliqué.

La logique de filtrage fonctionne en fonction de la valeur fournie dans le paramètre "Clé de filtre".
Nombre maximal d'enregistrements à renvoyer Integer 50 Non Spécifiez le nombre d'enregistrements à renvoyer. Si aucune valeur n'est fournie, l'action renvoie 50 enregistrements.

Date d'exécution

Cette action ne s'applique pas aux entités.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur Exemple
is_success Vrai/Faux is_success=False
Résultat JSON
[
    {
        "id": 245687,
        "name": "Apply All Patches",
        "policy_type_name": "patch",
        "organization_id": 104513,
        "configuration": {
            "auto_patch": false,
            "patch_rule": "all",
            "auto_reboot": false,
            "notify_user": false,
            "include_optional": true,
            "notify_reboot_user": true,
            "missed_patch_window": true,
            "custom_notification_max_delays": 3,
            "custom_notification_deferment_periods": [
                1,
                2,
                4
            ]
        },
        "schedule_days": 254,
        "schedule_weeks_of_month": 62,
        "schedule_months": 8190,
        "schedule_time": "17:00",
        "notes": "",
        "create_time": "2022-10-24T08:44:37+0000",
        "server_groups": [
            145150
        ],
        "server_count": 1,
        "status": "inactive"
    }
]
Mur des cas
Type de résultat Valeur / Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

Si des données sont disponibles (is_success=true) : "Successfully found policies for the provided criteria in Automox" (Règles trouvées avec succès pour les critères fournis dans Automox).

Si aucune donnée n'est disponible (is_success=false) : "Aucune règle n'a été trouvée pour les critères fournis dans Automox."

Si le paramètre "Valeur du filtre" est vide (is_success=true) : "Le filtre n'a pas été appliqué, car le paramètre "Valeur du filtre" est vide."

Si le paramètre "Logique de filtre" est défini sur "Non spécifié" (is_success=true) : "Le filtre n'a pas été appliqué, car le paramètre "Logique de filtre" n'est pas spécifié."

L'action doit échouer et arrêter l'exécution d'un playbook :

Si le paramètre "Clé de filtre" est défini sur "Sélectionner" et que la "Logique de filtre" est définie sur "Égal à" ou "Contient" : "Erreur lors de l'exécution de l'action "{nom de l'action}". Raison : vous devez sélectionner un champ dans le paramètre "Clé de filtre"."

Si une valeur non valide est fournie pour le paramètre "Nombre maximal d'enregistrements à renvoyer" : "Erreur lors de l'exécution de l'action "{nom de l'action}". Motif : "Une valeur non valide a été fournie pour "Nombre maximal d'enregistrements à renvoyer" : . Veuillez indiquer un nombre positif."

Si une erreur fatale est signalée (par exemple, des identifiants incorrects, une absence de connexion au serveur ou autre) : "Erreur lors de l'exécution de l'action "Lister les règles". Raison : {0}''.format(error.Stacktrace)

 Général
Tableau du mur des cas

Nom de la table : "Available Policies"

Colonnes du tableau :

  • Nom – nom
  • Type : policy_type_name
  • ID : id
  • État : état
  • Notes – notes
 Général

Ping

Testez la connectivité à Automox.

Paramètres

N/A

Date d'exécution

L'action ne s'exécute pas sur les entités et ne comporte pas de paramètres d'entrée obligatoires.

Résultats de l'action

Résultat du script
Nom du résultat du script Options de valeur Exemple
is_success Vrai/Faux is_success=False
Mur des cas
Type de résultat Valeur / Description Type
Message de sortie*

L'action ne doit pas échouer ni arrêter l'exécution d'un playbook :

Si l'opération réussit : "La connexion au serveur Automox a été établie avec succès à l'aide des paramètres de connexion fournis !"

L'action doit échouer et arrêter l'exécution d'un playbook :

Si l'opération échoue : "Échec de la connexion au serveur Automox. Error is {0}".format(exception.stacktrace)

 Général

Vous avez encore besoin d'aide ? Obtenez des réponses de membres de la communauté et de professionnels Google SecOps.