Represents the configuration of network discovery jobs. Configuration parameters have control over the behavior of network discovery jobs.
References to discoverytask are object references.
The name part of the discovery task object reference has the following components:
- discovery_task_oid
Example: discoverytask/ZG5zLm5ldHdvcmtfdmlldyQxMTk:current
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): discovery_task_oid, member_name.
The network discovery CSV file name.
Type
String.
Search
The field is not available for search.
Notes
The csv_file_name cannot be updated.
csv_file_name cannot be written.
Determines whether IP scanning is disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines whether VMWare scanning is disabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The discovery task identifier.
Type
String.
Search
The field is available for search via
Notes
The discovery_task_oid is part of the base object.
The discovery_task_oid cannot be updated.
discovery_task_oid cannot be written.
The Grid member that runs the discovery.
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
The member_name is part of the base object.
Determines whether to replace or merge new data with existing data.
Type
Bool.
Create
The default value is True.
Search
The field is not available for search.
Network discovery scanning mode.
Type
String.
Create
The default value is FULL.
Search
The field is not available for search.
Name of the network view in which target networks for network discovery reside.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
The list of the networks on which the network discovery will be invoked.
Type
A/An network object array.
This field supports nested return fields as described here.
Create
The default value is empty.
Search
The field is not available for search.
The number of times to perfrom ping for ICMP and FULL modes.
Type
Unsigned integer.
Create
The default value is 2.
Search
The field is not available for search.
The ping timeout for ICMP and FULL modes.
Type
Unsigned integer.
Create
The default value is 1000.
Search
The field is not available for search.
The schedule setting for network discovery task.
Type
A/An Schedule Setting struct.
Create
The default value is empty.
Search
The field is not available for search.
The network discovery process state.
Type
String.
Search
The field is not available for search.
Notes
The state cannot be updated.
state cannot be written.
Time when the network discovery process state was last updated.
Type
Timestamp.
Search
The field is not available for search.
Notes
The state_time cannot be updated.
state_time cannot be written.
The network discovery process descriptive status.
Type
String.
Search
The field is not available for search.
Notes
The status cannot be updated.
status cannot be written.
The time when the network discovery process status was last updated.
Type
Timestamp.
Search
The field is not available for search.
Notes
The status_time cannot be updated.
status_time cannot be written.
The ports to scan for FULL and TCP modes.
Type
A/An The network discovery TCP port struct array.
Create
The default value is:
[ { 'comment': 'ftp', 'number': 21},
{ 'comment': 'ssh', 'number': 22},
{ 'comment': 'telnet', 'number': 23},
{ 'comment': 'smtp', 'number': 25},
{ 'comment': 'finger', 'number': 79},
{ 'comment': 'http', 'number': 80},
{ 'comment': 'kerberos-sec', 'number': 88},
{ 'comment': 'pop3', 'number': 110},
{ 'comment': 'rpcbind', 'number': 111},
{ 'comment': 'auth', 'number': 113},
{ 'comment': 'msrpc', 'number': 135},
{ 'comment': 'netbios-ns', 'number': 137},
{ 'comment': 'netbios-dgm', 'number': 138},
{ 'comment': 'netbios-ssn', 'number': 139},
{ 'comment': 'imap', 'number': 143},
{ 'comment': 'https', 'number': 443},
{ 'comment': 'microsoft-ds', 'number': 445},
{ 'comment': 'login', 'number': 513},
{ 'comment': 'shell', 'number': 514},
{ 'comment': 'printer', 'number': 515},
{ 'comment': 'klogin', 'number': 543},
{ 'comment': 'kerberos', 'number': 750},
{ 'comment': 'kdm', 'number': 1024},
{ 'comment': 'NFS-or-IIS', 'number': 1025}]
Search
The field is not available for search.
The TCP scan techinque for FULL and TCP modes.
Type
String.
Create
The default value is SYN.
Search
The field is not available for search.
Name of the network view in which target networks for VMWare scanning reside.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is The default network view.
Search
The field is not available for search.
The list of VMware vSphere servers for VM discovery.
Type
A/An VMWare discovery server struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Use this method to apply a specific action to a network discovery process.
This function does not support multiple object matches when called as part of an atomic insertion operation.
Input fields
action ( String. Valid values are: “START”, “PAUSE”, “RESUME”, “END” ). This parameter is mandatory. The network discovery action.
Output fields
None
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| csv_file_name | String | N | Y | N | N/A |
| disable_ip_scanning | Bool | N | N | N | N/A |
| disable_vmware_scanning | Bool | N | N | N | N/A |
| discovery_task_oid | String | N | Y | Y | = |
| member_name | String | N | N | Y | N/A |
| merge_data | Bool | N | N | N | N/A |
| mode | String | N | N | N | N/A |
| network_view | String | N | N | N | N/A |
| networks | [obj] | N | N | N | N/A |
| ping_retries | Unsigned int | N | N | N | N/A |
| ping_timeout | Unsigned int | N | N | N | N/A |
| scheduled_run | struct | N | N | N | N/A |
| state | String | N | Y | N | N/A |
| state_time | Timestamp | N | Y | N | N/A |
| status | String | N | Y | N | N/A |
| status_time | Timestamp | N | Y | N | N/A |
| tcp_ports | [struct] | N | N | N | N/A |
| tcp_scan_technique | String | N | N | N | N/A |
| v_network_view | String | N | N | N | N/A |
| vservers | [struct] | N | N | N | N/A |
| warning | String | N | Y | N | N/A |
