Documentation Index

Fetch the complete documentation index at: https://help.nucleussec.com/llms.txt

Use this file to discover all available pages before exploring further.

Hosts

Prev Next

Fields

The following fields are specific to Host type asset:

Name

Description

Accepted Values or Format

host_name

Special*. The primary host name or FQDN for this host.

N/A

ip_address

Special*. The primary IP address for this host.

IPv4 or IPv6 addresses.

host_name_secondary

Optional. A list of hostnames and FQDNs distinct from the primary host_name field that this Host asset is associated with.

List of hostnames.

host_ip_secondary

Optional. A list of IP addresses distinct from the primary IP address that this Host asset is associated with.

List of IPv4 and/or IPv6 addresses.

mac_address

Optional. The MAC address for this host.

A 12-digit hexadecimal number represented by a colon-hexadecimal notation. E.g. 00:11:22:33:44:55

operating_system_name

Optional. The name of the operating system running on this host.

N/A

operating_system_version

Optional. The version of the operating system running on this host.

N/A

host_location

Optional. The location of this host.

N/A

Fields Marked Special*
At least one of host_name or ip_address is required for a host to be valid.

Host Asset Field Examples

JSON Schema

{
    "nucleus_import_version": "1",
    "scan_tool": "Asset",
    "scan_type": "Host",
    "assets": [
        {
            "host_name": "mysecretserver",
            "ip_address": "10.0.0.1",
            "host_name_secondary": [
                "2.my.secret.server.com",
                "3.my.secret.server.com"
            ],
            "host_ip_secondary": [
                "10.0.1.1",
                "10.0.2.1"
            ],
            "host_fqdn": "my.secret.server.com",
            "mac_address": "00:11:22:33:44:55",
            "operating_system_name": "Microsoft Windows 10 Enterprise",
            "operating_system_version": "12345",
            "host_location": "Data Center 1"
        }
    ]
}

Example XML

<nucleusCustomScan>
    <nucleus_import_version>1</nucleus_import_version>
    <scan_tool>Asset</scan_tool>
    <scan_type>Host</scan_type>
    <assets>
        <asset>
            <host_name>mysecretserver</host_name>
            <ip_address>1.0.0.1</ip_address>
            <host_name_secondary>
                <host_name>2.my.secret.server.com</host_name>
                <host_name>3.my.secret.server.com</host_name>
            </host_name_secondary>
            <host_ip_secondary>
                <ip_address>10.0.1.1</ip_address>
                <ip_address>10.0.2.1</ip_address>
            </host_ip_secondary>
            <host_fqdn>my.secret.server.com</host_fqdn>
            <mac_address>00:11:22:33:44:55</mac_address>
            <operating_system_name>Microsoft Windows 10 Enterprise</operating_system_name>
            <operating_system_version>12345</operating_system_version>
            <host_location>Data Center 1</host_location>
        </asset>
    </assets>
</nucleusCustomScan>

Example CSV

nucleus_import_version,scan_tool,scan_type,host_name,ip_address,host_name_secondary,host_ip_secondary,host_fqdn,mac_address,operating_system_name,operating_system_version,host_location
1,Asset,Host,mysecretserver,10.0.0.1,2.my.secret.server.com;3.my.secret.server.com,10.0.1.1;10.0.2.1,my.secret.server.com,00:11:22: