Integrar o Automox ao Google SecOps

Neste documento, descrevemos como integrar o Automox ao Google Security Operations (Google SecOps).

Versão da integração: 5.0

Parâmetros de integração

Use os seguintes parâmetros para configurar a integração:

Nome de exibição do parâmetro Tipo Valor padrão É obrigatório Descrição
Raiz da API String https://#123;#123;api_root#125;#125; Sim Raiz da API da instância do Automox.
Chave de API Senha N/A Não Chave de API da instância do Automox.
Verificar SSL Caixa de seleção Selecionado Sim Se ativada, verifica se o certificado SSL da conexão com o Automox é válido.

Para instruções sobre como configurar uma integração no Google SecOps, consulte Configurar integrações.

É possível fazer mudanças mais tarde, se necessário. Depois de configurar uma instância de integração, você pode usá-la em playbooks. Para mais informações sobre como configurar e oferecer suporte a várias instâncias, consulte Suporte a várias instâncias.

Como gerar uma chave de API

Para mais informações sobre como gerar uma chave de API, consulte a etapa Encontrar sua chave de API no console disponível no Guia para iniciantes sobre como começar a usar a API Automox documento.

Ações

Para mais informações sobre ações, consulte Responder a ações pendentes da sua mesa de trabalho e Realizar uma ação manual.

Enriquecer entidades

Aprimore entidades usando informações do Automox.

Parâmetros

Nome do parâmetro Tipo Valor padrão É obrigatório Descrição
Retornar patches Caixa de seleção Selecionado Não

Se ativada, a ação retorna uma lista de patches que precisam ser atualizados na máquina.

Observação:a ação não retorna patches instalados ou ignorados.

Número máximo de patches a serem retornados Número inteiro 50 Não Especifique o número de patches a serem retornados. Se nada for fornecido, a ação vai retornar 50 patches.

Data de execução

Essa ação é executada nas seguintes entidades:

  • Endereço IP
  • Nome do host

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor Exemplo
is_success Verdadeiro/Falso is_success=False
Resultado do 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
        }
    ]
}
Enriquecimento de entidades
Nome do campo de enriquecimento Lógica: quando aplicar
ID Quando disponível em JSON
agent_version Quando disponível em JSON
em compliance Quando disponível em JSON
conectado Quando disponível em JSON
create_time Quando disponível em JSON
custom_name Quando disponível em JSON
ip_addrs_private Quando disponível em JSON
last_disconnect_time Quando disponível em JSON
last_logged_in_user Quando disponível em JSON
last_update_time Quando disponível em JSON
os Quando disponível em JSON
pending_patches Quando disponível em JSON
tags Quando disponível em JSON
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se os dados estiverem disponíveis para uma entidade (is_success=true): "As seguintes entidades foram enriquecidas com sucesso usando informações do Automox: {entity.identifier}".

Se os dados não estiverem disponíveis para uma entidade (is_success=true): "Não foi possível enriquecer as seguintes entidades usando informações do Automox: {entity.identifier}"

Se os dados não estiverem disponíveis para todas as entidades (is_success=false): "Nenhuma das entidades fornecidas foi enriquecida".

A ação precisa falhar e interromper a execução de um playbook:

Se um erro fatal for informado, como credenciais incorretas, sem conexão com o servidor ou outro: "Erro ao executar a ação "Enriquecer entidades". Motivo: {0}''.format(error.Stacktrace)

Geral
Tabela do painel de casos

Título: {entity.identifier}

Colunas:

  • Chave
  • Valor
Entidade

Executar comando do dispositivo

Execute um comando no endpoint no Automox.

Parâmetros

Nome do parâmetro Tipo Valor padrão É obrigatório Descrição
Comando DDL

Verificar dispositivo

Valores possíveis:

  • Verificar dispositivo
  • Instalar patches específicos
  • Instalar todos os patches disponíveis
  • Reiniciar dispositivo
Não

Especifique um comando que precisa ser executado no dispositivo.

Observação:se a opção "Instalar patches específicos" estiver selecionada, o parâmetro "Nomes de patch" será obrigatório.

Nomes de patch CSV N/A Não Especifique uma lista separada por vírgulas de patches que precisam ser instalados.

Data de execução

Essa ação é executada nas seguintes entidades:

  • Endereço IP
  • Nome do host

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor Exemplo
is_success Verdadeiro/Falso is_success=False
Resultado do 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."
}
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se o dispositivo for encontrado e estiver conectado (is_success=true): "O comando "{Command}" foi executado com sucesso nas seguintes entidades no Automox: {entity.identifier}. Verifique o resultado JSON para garantir que o comando foi executado corretamente."

Se o dispositivo não for encontrado ou estiver conectado a uma entidade (is_success=true): "Não foi possível executar o comando "{Command}" nas seguintes entidades no Automox: {entity.identifier}. Verifique a ortografia e a conectividade."

Se o dispositivo não for encontrado ou estiver conectado a todas as entidades (is_success=false): "Nenhum comando foi executado nas entidades fornecidas. Verifique a ortografia e a conectividade."

A ação precisa falhar e interromper a execução de um playbook:

Se um erro fatal, como credenciais incorretas, falta de conexão com o servidor ou outro, for informado: "Erro ao executar a ação "Executar comando do dispositivo". Motivo: {0}''.format(error.Stacktrace)

Geral

Executar política

Execute uma política no Automox.

Parâmetros

Nome do parâmetro Tipo Valor padrão É obrigatório Descrição
Escopo da correção DDL

Todos os dispositivos

Valores possíveis:

  • Somente entidades
  • Todos os dispositivos
Não

Especifique o escopo da correção para a ação.

Se a opção "Somente entidades" estiver selecionada, a ação vai executar políticas apenas nas entidades válidas no escopo.

Se a opção "Todos os dispositivos" estiver selecionada, a ação vai executar a política em todos os dispositivos da organização.

Nome da política String N/A Não Especifique o nome da política que precisa ser executada.

Data de execução

Essa ação é executada nas seguintes entidades:

  • Endereço IP
  • Nome do host

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor Exemplo
is_success Verdadeiro/Falso is_success=False
Resultado do JSON
{
"status": "done/failure if entity not found"
}
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se o servidor foi corrigido e a ação foi bem-sucedida para uma entidade (is_success=true): "A política {Policy} foi executada nas seguintes entidades no Automox: {entity.identifier}".

Se o servidor foi corrigido e um servidor não foi encontrado (is_success=true): "Não foi possível executar a política {Policy} nas seguintes entidades no Automox: {entity.identifier}."

Se o servidor foi corrigido e todos os servidores não foram encontrados (is_success=false): "Nenhuma entidade foi encontrada. A política {Policy} não foi executada."

Se corrigir todos os servidores (is_success=true): "A política {Policy} foi executada com sucesso no Automox."

A ação precisa falhar e interromper a execução de um playbook:

Se um erro fatal, como credenciais incorretas, falta de conexão com o servidor ou outro, for informado: "Erro ao executar a ação "Executar política". Motivo: {0}''.format(error.Stacktrace)

Se a política não for encontrada: "Erro ao executar a ação "Executar política". Motivo: a política "{nome da política}" não foi encontrada no Automox. Verifique a ortografia.""

Geral

Listar políticas

Liste as políticas disponíveis no Automox.

Parâmetros

Nome do parâmetro Tipo Valor padrão É obrigatório Descrição
Chave de filtro DDL

Selecione uma opção.

Valores possíveis:

  • Nome
  • ID
  • Nome do tipo de política
  • Status
Não Especifique a chave que precisa ser usada para filtrar a política.
Lógica de filtro DDL

Não especificado

Valores possíveis:

  • Não especificado
  • Igual
  • Contém
Não

Especifique a lógica de filtro que deve ser aplicada.

A lógica de filtragem funciona com base no valor fornecido no parâmetro "Chave de filtro".

Valor do filtro String N/A Não

Especifique o valor que deve ser usado no filtro.

Se "Igual a" estiver selecionado, a ação tentará encontrar a correspondência exata entre os resultados. Se "Contém" estiver selecionado, a ação tentará encontrar resultados que contenham essa substring.

Se nada for fornecido nesse parâmetro, o filtro não será aplicado.

A lógica de filtragem funciona com base no valor fornecido no parâmetro "Chave de filtro".

Número máximo de registros a serem retornados Número inteiro 50 Não Especifique o número de registros a serem retornados. Se nada for fornecido, a ação vai retornar 50 registros.

Data de execução

Essa ação não é executada em entidades.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor Exemplo
is_success Verdadeiro/Falso is_success=False
Resultado do 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"
    }
]
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se os dados estiverem disponíveis (is_success=true): "Políticas encontradas com sucesso para os critérios fornecidos no Automox".

Se os dados não estiverem disponíveis (is_success=false): "Nenhuma política foi encontrada para os critérios fornecidos no Automox".

Se o parâmetro "Valor do filtro" estiver vazio (is_success=true): "O filtro não foi aplicado porque o parâmetro "Valor do filtro" está vazio."

Se o parâmetro "Lógica de filtro" estiver definido como "Não especificado" (is_success=true): "O filtro não foi aplicado porque o parâmetro "Lógica de filtro" não foi especificado".

A ação precisa falhar e interromper a execução de um playbook:

Se o parâmetro "Chave de filtro" estiver definido como "Selecionar um" e a "Lógica de filtro" estiver definida como "Igual a" ou "Contém": "Erro ao executar a ação "{nome da ação}". Motivo: é necessário selecionar um campo no parâmetro "Chave de filtro".

Se um valor inválido for fornecido para o parâmetro "Número máximo de registros a serem retornados": "Erro ao executar a ação "{nome da ação}". Motivo: "Um valor inválido foi fornecido para "Número máximo de registros a serem retornados": . É preciso informar um número positivo"."

Se um erro fatal, como credenciais incorretas, falta de conexão com o servidor ou outro, for informado: "Erro ao executar a ação "List Policies". Motivo: {0}''.format(error.Stacktrace)

Geral
Tabela do painel de casos

Nome da tabela:Available Policies

Colunas da tabela:

  • Nome: nome
  • Tipo: policy_type_name
  • ID: id
  • Status - status
  • Notas - notas
Geral

Ping

Teste a conectividade com o Automox.

Parâmetros

N/A

Data de execução

A ação não é executada em entidades nem tem parâmetros de entrada obrigatórios.

Resultados da ação

Resultado do script
Nome do resultado do script Opções de valor Exemplo
is_success Verdadeiro/Falso is_success=False
Painel de casos
Tipo de resultado Valor / Descrição Tipo
Mensagem de saída*

A ação não pode falhar nem interromper a execução de um playbook:

Se a conexão for bem-sucedida: "Conexão bem-sucedida com o servidor do Automox usando os parâmetros fornecidos".

A ação precisa falhar e interromper a execução de um playbook:

Se não for concluída: "Não foi possível se conectar ao servidor do Automox! O erro é {0}".format(exception.stacktrace)

Geral

Precisa de mais ajuda? Receba respostas de membros da comunidade e profissionais do Google SecOps.