Check IP Subnet | docs.d3security

Last updated: Aug 07, 2024

This command is designed to verify whether a set of IP addresses falls within specified subnets. The process typically involves comparing each IP address against a list of subnet ranges to determine if it belongs to any of the subnets.

Implementation	System
Command Category	Cyber Utility
Tags	Network ARTIFACT IP

Inputs

Parameter Name	Required/Optional	Description	Sample Data
IP Address List	Required	The IP list for subnet checking	`["192.168.0.1", "192.168.1.1"]`
Subnet List	Required	The subnet list for subnet checking	`["192.168.0.0/24", "192.168.0.0/16"]`

Output

Return Data

The returned result of this command. If some required parameters are not defined, this returned data could be empty. The returned result can be passed down directly to a subsequent command in playbooks.

Sample Data

JSON

Successful

Context Data

The response data from the utility command.

Sample Data

JSON

[
    {
        "count": 1,
        "subnet": "192.168.0.0/24",
        "ipAddressList": [
            "192.168.0.1"
        ]
    },
    {
        "count": 2,
        "subnet": "192.168.0.0/16",
        "ipAddressList": [
            "192.168.0.1",
            "192.168.1.1"
        ]
    }
]

Remote Command API

The D3 command API allows you to send requests to D3 SOAR to execute this utility command via REST API.

Request

POST

https:/{base_url}/{api_namespace}/api/Command/checkIPSubnet

Headers

Please refer to the page Webhook Configuration Guide - Authentication Method: API Keys for more details.

Request Body

JSON

{
  "Username": <Username here>,
  "Site": <Site here>,
  "CommandParams":{
    "IP Address List": <The IP list for subnet checking>,
    "Subnet List": <The subnet list for subnet checking>
  }
}

Body Parameters

Parameter Name	Type	Required/Optional	Description
Username	`string`	Required	The username of your D3 SOAR account.
Site	`string`	Required	The D3 SOAR site to run the remote command.
IP Address List	`array<string>`	Required	The IP list for subnet checking
Subnet List	`array<string>`	Required	The subnet list for subnet checking

Sample Request

Sample Data

JSON

{
  "Username": "Admin",
  "Site": "Security Operations",
  "CommandParams": {
    "IP Address List": [
      "192.168.0.1",
      "192.168.1.1"
    ],
    "Subnet List": [
      "192.168.0.0/24",
      "192.168.0.0/16"
    ]
  }
}

Response

Response Fields

Field Name	Type	Description
error	`string`	The error message if the API request has failed.
returnData	`string`	The return data from the API request.
contextData	`array<JSON Object>`	The context data from the API request.

Sample Response

JSON

{
    "error": "",
    "returnData": "Successful",
    "contextData": [
      {
          "count": 1,
          "subnet": "192.168.0.0/24",
          "ipAddressList": [
              "192.168.0.1"
          ]
      },
      {
          "count": 2,
          "subnet": "192.168.0.0/16",
          "ipAddressList": [
              "192.168.0.1",
              "192.168.1.1"
          ]
      }
    ]
}