discovery:memberproperties : The Grid discovery member properties object.

The object provides information about the Grid member discovery properties.

Object Reference

References to discovery:memberproperties are object references.

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

  • The name of the discovery member.
Example:
discovery:memberproperties/ ZGlzY292ZXJ5Lm1lbWJlcl9kaXNjb3ZlcnlfcHJvcGVydGllcyQxMg: test_discovery.com

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • 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): discovery_member.

address

address

The Grid member address IP address.

Type

String.

Search

The field is not available for search.

Notes

The address cannot be updated.

address cannot be written.

cli_credentials

cli_credentials

Discovery CLI credentials.

Type

A/An CLI credential struct array.

Create

The default value is The default values is inherited from the Grid.

Search

The field is not available for search.

Notes

cli_credentials is associated with the field use_cli_credentials (see use flag).

default_seed_routers

default_seed_routers

Default seed routers.

Type

A/An The seed router structure struct array.

Search

The field is not available for search.

Notes

The default_seed_routers cannot be updated.

default_seed_routers cannot be written.

discovery_member

discovery_member

The name of the network discovery Grid member.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The discovery_member is part of the base object.

The discovery_member cannot be updated.

discovery_member cannot be written.

enable_service

enable_service

Determines if the discovery service is enabled.

Type

Bool.

Create

The default value is False.

Search

The field is available for search via

  • ‘=’ (exact equality)

gateway_seed_routers

gateway_seed_routers

Gateway seed routers.

Type

A/An The seed router structure struct array.

Search

The field is not available for search.

Notes

The gateway_seed_routers cannot be updated.

gateway_seed_routers cannot be written.

is_sa

is_sa

Determines if the standalone mode for discovery network monitor is enabled or not.

Type

Bool.

Create

The default value is False.

Search

The field is available for search via

  • ‘=’ (exact equality)

role

role

Discovery member role.

Type

String.

Valid values are:
  • DNM
  • DNP
  • NONE

Create

The default value is The default values could be ‘DNM’ or ‘DNP, its value depends on member creation order.

Search

The field is available for search via

  • ‘=’ (exact equality)

scan_interfaces

scan_interfaces

Discovery networks to which the member is assigned.

Type

A/An The discovery scan interface structure struct array.

Create

The default value is:

[{ 'network_view': 'default', 'scan_virtual_ip': None, 'type': 'LAN1'}]

Search

The field is not available for search.

sdn_configs

sdn_configs

List of SDN/SDWAN controller configurations.

Type

A/An The SDN/SDWAN configuration structure struct array.

Create

The default value is:

empty

Search

The field is not available for search.

seed_routers

seed_routers

Seed routers.

Type

A/An The seed router structure struct array.

Create

The default value is:

empty

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 The default values is inherited from the Grid.

Search

The field is not available for search.

Notes

snmpv1v2_credentials is associated with the field use_snmpv1v2_credentials (see use flag).

snmpv3_credentials

snmpv3_credentials

Discovery SNMP v3 credentials.

Type

A/An SNMP v3 Credential struct array.

Create

The default value is The default values is inherited from the Grid.

Search

The field is not available for search.

Notes

snmpv3_credentials is associated with the field use_snmpv3_credentials (see use flag).

use_cli_credentials

use_cli_credentials

Use flag for: cli_credentials

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_snmpv1v2_credentials

use_snmpv1v2_credentials

Use flag for: snmpv1v2_credentials

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_snmpv3_credentials

use_snmpv3_credentials

Use flag for: snmpv3_credentials

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

Fields List

Field Type Req R/O Base Search
address String N Y N N/A
cli_credentials [struct] N N N N/A
default_seed_routers [struct] N Y N N/A
discovery_member String N Y Y =
enable_service Bool N N N =
gateway_seed_routers [struct] N Y N N/A
is_sa Bool N N N =
role String N N N =
scan_interfaces [struct] N N N N/A
sdn_configs [struct] N N N N/A
seed_routers [struct] N N N N/A
snmpv1v2_credentials [struct] N N N N/A
snmpv3_credentials [struct] N N N N/A
use_cli_credentials Bool N N N N/A
use_snmpv1v2_credentials Bool N N N N/A
use_snmpv3_credentials Bool N N N N/A