Map Template Parameters

Map template parameters are below. The default value when creating a new template is shown in bold where applicable.

Input ParametersInput Parameters

Parameter

Required/Optional

Data
Type

Description

General Info

 

 

 

action={create|update}

Required

String

Specify the action you want to take.

report_format=xml

Required

File

XML report format is supported.

template_id={value}

Required for update request

Integer

The template ID to update.

title={value}

Optional

String

A string value for the title (max of 64 characters).

owner={value}

Optional

String

The name of the owner of this template.

See Template Owner.

global={0|1}

Optional

Integer

Share this report template with other users by making it global. Specify 1 to make it global.

Display Options

 

 

 

map_sort_by={ipaddress|dns|netbios|router|operatingsystem}

Optional

Boolean

Sort and group the results of the report by any of the following:

IP Address = ipaddress

DNS = dns

NetBIOS = netbios

Router = router

Operating System = OS

map_related_info_lastscandate={0|1}

Optional

Integer

Specify 1 to include the last scan date.

map_related_info_assetgroups={0|1}

Optional

Integer

Specify 1 to include the asset groups.

map_related_info_authenticationrecords={0|1}

Optional

Integer

Specify 1 to include the authentication records.

map_related_info_discoverymethod={0|1}

Optional

Integer

Specify 1 to include the discovery method.

display_custom_footer={0|1}

Optional

Integer

Specify 1 to include custom text in the report footer.

display_custom_footer_text={value}

Optional

String

Specify custom text like a disclosure statement or data classification (e.g. Public, Confidential). The text you enter will appear in all reports generated from this template, except reports in XML and CSV formats. Length is maximum 4000 characters.

map_exclude_account_id={0|1}

Optional

Integer

Specify 1 to exclude the account login ID in the filename of downloaded reports. Use this option to remove the login ID from the filename.

Filter Options

 

 

 

map_included_hosttypes_innetblock={0|1}

Optional

Integer

Specify 1 to filter the report by host types - In Netblock.

map_included_hosttypes_scannable={0|1}

Optional

Integer

Specify 1 to filter the report by host types -  Scannable.

map_included_hosttypes_live={0|1}

Optional

Integer

Specify 1 to filter the report by host types - Live.

map_included_hosttypes_approved={0|1}

Optional

Integer

Specify 1 to filter the report by host types - Approved.

map_included_hosttypes_outofnetblock={0|1}

Optional

Integer

Specify 1 to filter the report by host types - Not In Netblock.

map_included_hosttypes_notscannable={0|1}

Optional

Integer

Specify 1 to filter the report by host types - Not Scannable.

map_included_hosttypes_notlive={0|1}

Optional

Integer

Specify 1 to filter the report by host types - Not Live.

map_included_hosttypes_rogue={0|1}

Optional

Integer

Specify 1 to filter the report by host types - Rouge.

Included Discovery Methods

 

 

Include at least one.

map_idm_tcp={0|1}

Optional

Integer

Specify 1 to filter the report by discovery methods - TCP.

map_idm_udp={0|1}

Optional

Integer

Specify 1 to filter the report by discovery methods - UDP.

map_idm_traceroute={0|1}

Optional

Integer

Specify 1 to filter the report by discovery methods - TraceRoute.

map_idm_other={0|1}

Optional

Integer

Specify 1 to filter the report by discovery methods - Other.

map_idm_dns={0|1}

Optional

Integer

Specify 1 to filter the report by discovery methods - DNS.

map_idm_icmp={0|1}

Optional

Integer

Specify 1 to filter the report by discovery methods - ICMP.

map_idm_auth={0|1}

Optional

Integer

Specify 1 to filter the report by discovery methods - AUTH.

Included Status Levels

 

 

Only applicable for differential map reports.

map_included_statuses_added={0|1}

Optional

Integer

Specify 1 to filter the report by statuses - Added.

map_included_statuses_removed={0|1}

Optional

Integer

Specify 1 to filter the report by statuses - Removed.

map_included_statuses_active={0|1}

Optional

Integer

Specify 1 to filter the report by statuses - Active.

dns_exclusions={none|DNS|DNS-DNSZone}

Optional

Boolean

Exclude hosts discovered only via:

none = None

DNS = DNS

DNS-DNSZone = DNS and/or DNS Zone Transfer

included_os={value}

Optional

String

Specify the operating system name to filter hosts. For example, to only report on Linux hosts make sure you provide the operating system name for Linux.

Multiple operating system names can be provided using values separated by a comma.

Specify ALL to include all operating systems.

See Identified OS.