discovery:gridproperties : The Grid discovery properties object.

The object provides information about the Grid discovery properties.

Object Reference

References to discovery:gridproperties are object references.

The name part of the discovery:gridproperties object reference has the following components:

  • The grid name.
Example:
discovery:gridproperties/ ZGlzY292ZXJ5LmNsdXN0ZXJfZGlzY292ZXJ5X3Byb3BlcnRpZXMkMA:Infoblox

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Global search (searches via the search object)
  • Scheduling
  • CSV export

The object cannot be managed on Cloud Platform members.

Fields

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): grid_name.

advanced_polling_settings

advanced_polling_settings

Discovery advanced polling settings.

Type

A/An The advanced polling settings structure struct.

Create

The default value is:

  { 'arp_aggregate_limit': 30,
'arp_cache_refresh_interval': 300,
'dhcp_router_as_seed': True,
'disable_discovery_outside_ipam': False,
'enable_purge_expired_endhost_data': True,
'ping_retries': 2,
'ping_sweep_interval': 86400,
'ping_timeout': 1000,
'polling_authenticate_snmpv2c_or_later_only': True,
'purge_expired_device_data': 7,
'purge_expired_endhost_data': 86400,
'route_limit': 3000,
'syslog_ipam_events': False,
'syslog_network_events': True,
'tcp_scan_technique': 'SYN'}

Search

The field is not available for search.

advisor_settings

advisor_settings

Advisor settings.

Type

A/An Advisor Settings structure struct.

Create

The default value is:

  { 'auth_type': 'TOKEN',
'enable_proxy': False,
'execution_hour': 3,
'execution_interval': 86400,
'min_severity': '8.0',
'use_proxy_username_passwd': False}

Search

The field is not available for search.

auto_conversion_settings

auto_conversion_settings

Automatic conversion settings.

Type

A/An This struct contains settings for automatic conversion struct array.

Create

The default value is:

empty

Search

The field is not available for search.

basic_polling_settings

basic_polling_settings

Discovery basic polling settings.

Type

A/An Basic Poll Settings struct.

Create

The default value is:

  { 'auto_arp_refresh_before_switch_port_polling': True,
'cli_collection': True,
'complete_ping_sweep': False,
'device_profile': False,
'netbios_scanning': False,
'port_scanning': False,
'smart_subnet_ping_sweep': False,
'snmp_collection': True,
'switch_port_data_collection_polling': 'PERIODIC',
'switch_port_data_collection_polling_interval': 3600}

Search

The field is not available for search.

cli_credentials

cli_credentials

Discovery CLI credentials.

Type

A/An CLI credential struct array.

Create

The default value is:

empty

Search

The field is not available for search.

discovery_blackout_setting

discovery_blackout_setting

Discovery blackout setting.

Type

A/An Blackout Setting struct.

Create

The default value is:

{ 'enable_blackout': False}

Search

The field is not available for search.

dns_lookup_option

dns_lookup_option

The type of the devices the DNS processor operates on.

Type

String.

Valid values are:
  • ALL
  • INFRAONLY
  • OFF

Create

The default value is INFRAONLY.

Search

The field is not available for search.

dns_lookup_throttle

dns_lookup_throttle

The percentage of available capacity the DNS processor operates at.

Valid values are unsigned integer between 1 and 100, inclusive.

Type

Unsigned integer.

Create

The default value is 100.

Search

The field is not available for search.

enable_advisor

enable_advisor

Advisor application enabled/disabled.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_auto_conversion

enable_auto_conversion

The flag that enables automatic conversion of discovered data.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

enable_auto_updates

enable_auto_updates

The flag that enables updating discovered data for managed objects.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

grid_name

grid_name

The Grid name.

Type

String.

Search

The field is not available for search.

Notes

The grid_name is part of the base object.

The grid_name cannot be updated.

grid_name cannot be written.

ignore_conflict_duration

ignore_conflict_duration

Determines the timeout to ignore the discovery conflict duration (in seconds).

Type

Unsigned integer.

Create

The default value is 86400.

Search

The field is not available for search.

port_control_blackout_setting

port_control_blackout_setting

Port control blackout setting.

Type

A/An Blackout Setting struct.

Create

The default value is:

{ 'enable_blackout': False}

Search

The field is not available for search.

ports

ports

Ports to scan.

Type

A/An The discovery port structure struct array.

Create

The default value is:

  [ { 'comment': 'tcpmux', 'port': 1, 'type': 'TCP'},
{ 'comment': 'echo', 'port': 7, 'type': 'TCP'},
{ 'comment': 'discard', 'port': 9, 'type': 'TCP'},
{ 'comment': 'systat', 'port': 11, 'type': 'TCP'},
{ 'comment': 'daytime', 'port': 13, 'type': 'TCP'},
{ 'comment': 'qotd', 'port': 17, 'type': 'TCP'},
{ 'comment': 'chargen', 'port': 19, 'type': 'TCP'},
{ 'comment': 'ftp-data', 'port': 20, 'type': 'TCP'},
{ 'comment': 'ftp', 'port': 21, 'type': 'TCP'},
{ 'comment': 'telnet', 'port': 23, 'type': 'TCP'},
{ 'comment': 'smtp', 'port': 25, 'type': 'TCP'},
{ 'comment': 'time', 'port': 37, 'type': 'TCP'},
{ 'comment': 'nameserver', 'port': 42, 'type': 'TCP'},
{ 'comment': 'domain', 'port': 53, 'type': 'TCP'},
{ 'comment': 'bootps', 'port': 67, 'type': 'UDP'},
{ 'comment': 'bootps', 'port': 67, 'type': 'TCP'},
{ 'comment': 'bootpc', 'port': 68, 'type': 'TCP'},
{ 'comment': 'tftp', 'port': 69, 'type': 'TCP'},
{ 'comment': 'http', 'port': 80, 'type': 'TCP'},
{ 'comment': 'kerberos', 'port': 88, 'type': 'TCP'},
{ 'comment': 'linuxconf', 'port': 98, 'type': 'TCP'},
{ 'comment': 'pop2', 'port': 109, 'type': 'TCP'},
{ 'comment': 'pop3', 'port': 110, 'type': 'TCP'},
{ 'comment': 'sunrpc', 'port': 111, 'type': 'TCP'},
{ 'comment': 'sftp', 'port': 115, 'type': 'TCP'},
{ 'comment': 'ntp', 'port': 123, 'type': 'TCP'},
{ 'comment': 'netbios-ns', 'port': 137, 'type': 'TCP'},
{ 'comment': 'netbios-dgm', 'port': 138, 'type': 'TCP'},
{ 'comment': 'netbios-ssn', 'port': 139, 'type': 'TCP'},
{ 'comment': 'imap', 'port': 143, 'type': 'TCP'},
{ 'comment': 'snmp', 'port': 161, 'type': 'TCP'},
{ 'comment': 'imap3', 'port': 220, 'type': 'TCP'},
{ 'comment': 'bgmp', 'port': 264, 'type': 'TCP'},
{ 'comment': 'https', 'port': 443, 'type': 'TCP'},
{ 'comment': 'smpts', 'port': 465, 'type': 'TCP'},
{ 'comment': 'printer', 'port': 515, 'type': 'TCP'},
{ 'comment': 'socks', 'port': 1080, 'type': 'TCP'},
{ 'comment': 'mysql', 'port': 3306, 'type': 'TCP'},
{ 'comment': 'postgres', 'port': 5432, 'type': 'TCP'},
{ 'comment': 'x11', 'port': 6000, 'type': 'TCP'},
{ 'comment': 'ircd', 'port': 6667, 'type': 'TCP'},
{ 'comment': 'webcache', 'port': 8080, 'type': 'TCP'},
{ 'comment': 'jetdirect', 'port': 9100, 'type': 'TCP'}]

Search

The field is not available for search.

same_port_control_discovery_blackout

same_port_control_discovery_blackout

Determines if the same port control is used for discovery blackout.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

snmpv1v2_credentials

snmpv1v2_credentials

Discovery SNMP v1 and v2 credentials.

Type

A/An SNMP Credential struct array.

Create

The default value is:

empty

Search

The field is not available for search.

snmpv3_credentials

snmpv3_credentials

Discovery SNMP v3 credentials.

Type

A/An SNMP v3 Credential struct array.

Create

The default value is:

empty

Search

The field is not available for search.

unmanaged_ips_limit

unmanaged_ips_limit

Limit of discovered unmanaged IP address which determines how frequently the user is notified about the new unmanaged IP address in a particular network.

Type

Unsigned integer.

Create

The default value is 20.

Search

The field is not available for search.

unmanaged_ips_timeout

unmanaged_ips_timeout

Determines the timeout between two notifications (in seconds) about the new unmanaged IP address in a particular network. The value must be between 60 seconds and the number of seconds remaining to Jan 2038.

Type

Unsigned integer.

Create

The default value is 300.

Search

The field is not available for search.

vrf_mapping_policy

vrf_mapping_policy

The policy type used to define the behavior of the VRF mapping.

Type

String.

Valid values are:
  • NONE
  • RULE_AND_INTERNAL_BASED
  • RULE_BASED

Create

The default value is NONE.

Search

The field is not available for search.

vrf_mapping_rules

vrf_mapping_rules

VRF mapping rules.

Type

A/An This struct contains VRF Mapping Rule struct array.

Create

The default value is:

empty

Search

The field is not available for search.

Function Calls

advisor_run_now

This function is used to launch Advisor immediately

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

None

Output fields

exec_status ( String. ) OK if funccall succeeded, otherwise ERROR.

advisor_test_connection

This function is used to test connection to Advisor central

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

address ( String. ). This parameter is mandatory. Host name or ip address of the Advisor server

auth_token ( String. ) Advisor AUTH token

auth_type ( String. Valid values are: “TOKEN”, “CREDS” ). This parameter is mandatory. Authentication type used for Advisor server

enable_proxy ( Bool. ) Use proxy server if true.

min_severity ( String. ). This parameter is mandatory. Advisor minimal severity

network_interface_type ( String. Valid values are: “MGMT”, “LAN1”, “LAN2”, “VLAN” ). This parameter is mandatory. The type of the network interface on consolidator member.

network_interface_virtual_ip ( String. ) The interface for Advisor application on consolidator member.

password ( String. ) Password for Advisor server

port ( Unsigned integer. ). This parameter is mandatory. Port number the Advisor server listens on

proxy_address ( String. ) Host name or ip address of the proxy server.

proxy_password ( String. ) Proxy password.

proxy_port ( Unsigned integer. ) Port number the proxy listens on.

proxy_username ( String. ) Proxy username.

use_proxy_username_passwd ( Bool. ) Is proxy authorization required?

username ( String. ) Username for Advisor server

Output fields

last_exec_details ( String. ) Details of the last execution attempt of Advisor. Describes the error or warning with a string

last_exec_status ( String. Valid values are: “OK”, “WARNING”, “ERROR” ) Result of the last execution attempt of Advisor

last_exec_time ( Timestamp. ) Timestamp of the Advisor last execution attempt’

diagnostic

This function is used to execute a discovery diagnostic to help determine why a specific device is presenting difficulties in discovery.

For example, a given device may be reachable but may show an overall status of Failed in the Discovery Status GUI dialog. Discovery diagnostic steps through a complete discovery process based on the configuration on the Probe member to which the device is assigned. The diagnostic runs all the way from fetching the SNMP object ID information to the ARP table reading and to ICMP pings and traceroutes.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

address ( String. ). This parameter is mandatory. The IPv4 or IPv6 address of the device on which you want to perform the test. The discovery diagnostic runs a full discovery procedure against the specified IP address.

community_string ( String. ) The community string for the device if the required SNMP credential is not currently configured for the discovery member. It may not be necessary to enter a community string if the device is already discovered by NIOS and is a managed device.

discovery_member ( String. ) Host name of the discovery member to use. You must specify a discovery member or a network view.

enable_snmp_debug ( Bool. ) Determines whether SNMP debug is enabled. The default value is “True”.

force_test ( Bool. ) Determines if a diagnostic against the device is forced.

network_view ( String. ) Network view in which the IP address resides. NIOS conducts a discovery diagnostic for the IP address in the selected network view. You must specify a discovery member or a network view.

Output fields

session_id ( String. ) The diagnostic session ID which can be used to retrieve status.

diagnostic_status

This function is used to retrieve diagnostic status.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

session_id ( String. ). This parameter is mandatory. Session ID returned by the diagnostic function call.

start ( Integer. ). This parameter is mandatory. Start position of the text to return or be returned.

Output fields

end ( Integer. ) End position of the resulting text string.

session_id ( String. ) Session ID returned by the diagnostic function call.

start ( Integer. ) Start position of the text to return or be returned.

status ( String. Valid values are: “INPROGRESS”, “COMPLETED”, “FAILED” ) Status of the diagnostic.

text ( String. ) The resulting text string.

Fields List

Field Type Req R/O Base Search
advanced_polling_settings struct N N N N/A
advisor_settings struct N N N N/A
auto_conversion_settings [struct] N N N N/A
basic_polling_settings struct N N N N/A
cli_credentials [struct] N N N N/A
discovery_blackout_setting struct N N N N/A
dns_lookup_option String N N N N/A
dns_lookup_throttle Unsigned int N N N N/A
enable_advisor Bool N N N N/A
enable_auto_conversion Bool N N N N/A
enable_auto_updates Bool N N N N/A
grid_name String N Y Y N/A
ignore_conflict_duration Unsigned int N N N N/A
port_control_blackout_setting struct N N N N/A
ports [struct] N N N N/A
same_port_control_discovery_blackout Bool N N N N/A
snmpv1v2_credentials [struct] N N N N/A
snmpv3_credentials [struct] N N N N/A
unmanaged_ips_limit Unsigned int N N N N/A
unmanaged_ips_timeout Unsigned int N N N N/A
vrf_mapping_policy String N N N N/A
vrf_mapping_rules [struct] N N N N/A