record:host_ipv6addr : IPv6 Host address object.

An IPv6 host address is an object used to specify addresses in the record.host object.

Fields other than ipv6addr, host and configure_for_dhcp are returned only when configure_for_dhcp is set to True.

Object Reference

References to record:host_ipv6addr are object references. The name part of an IPv6 Host Address object reference has the following components:

  • Address of the record
  • Name of the host to which the IPv6 host address belongs
  • Name of the view

Example: record:host_ipv6addr/ZG5zvc3RjkuMC4xLg:abcd::/some.name.com/default

Restrictions

The object does not support the following operations:

  • Create (insert)
  • Delete
  • Permissions
  • Scheduling
  • CSV export

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): configure_for_dhcp, duid, host, ipv6addr.

The following fields are required to create this object:

Field Notes
ipv6addr See the field description for more information
ipv6prefix See the field description for more information
ipv6prefix_bits See the field description for more information

address_type

address_type

Type of the DHCP IPv6 Host Address object.

Type

String.

Valid values are:
  • ADDRESS
  • BOTH
  • PREFIX

Create

The default value is ADDRESS.

Search

The field is not available for search.

configure_for_dhcp

configure_for_dhcp

Set this to True to enable the DHCP configuration for this IPv6 host address.

Type

Bool.

Create

The default value is True.

Search

The field is not available for search.

Notes

The configure_for_dhcp is part of the base object.

discover_now_status

discover_now_status

The discovery status of this IPv6 Host Address.

Type

String.

Valid values are:
  • COMPLETE
  • FAILED
  • NONE
  • PENDING
  • RUNNING

Search

The field is not available for search.

Notes

The discover_now_status cannot be updated.

discover_now_status cannot be written.

discovered_data

discovered_data

The discovered data for this host address.

Type

A/An Discovered data struct.

Search

The field is not available for search.

Notes

The discovered_data cannot be updated.

discovered_data cannot be written.

domain_name

domain_name

Use this method to set or retrieve the domain_name value of the DHCP IPv6 Host Address object.

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.

Notes

domain_name is associated with the field use_domain_name (see use flag).

domain_name_servers

domain_name_servers

The IPv6 addresses of DNS recursive name servers to which the DHCP client can send name resolution requests. The DHCP server includes this information in the DNS Recursive Name Server option in Advertise, Rebind, Information-Request, and Reply messages.

Type

String array.

Create

The default value is empty.

Search

The field is not available for search.

Notes

domain_name_servers is associated with the field use_domain_name_servers (see use flag).

duid

duid

DHCPv6 Unique Identifier (DUID) of the address object.

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 available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The duid is part of the base object.

host

host

The host to which the IPv6 host address belongs, in FQDN format. It is only present when the host address object is not returned as part of a host.

Type

String.

Search

The field is not available for search.

Notes

The host is part of the base object.

The host cannot be updated.

host cannot be written.

ipv6addr

ipv6addr

The IPv6 Address prefix of the DHCP IPv6 Host Address object.

Type

String.

The field also supports automatic selection of the next available address in the specified IPv6 network or range. You can specify the IPv6 network or range in the following ways:

Using an IPv6 network or range WAPI reference:

  • func:nextavailableip:<reference>

Using an IPv6 network lookup (if the view is not specified, the default view will be used):

  • func:nextavailableip:<network>[,<network view>]

Using an IPv6 range lookup (if the view is not specified, the default view will be used):

  • func:nextavailableip:<start_addr-end_addr>[,<network view>]

Scheduled and approval operations are not supported when using the automatic IP selection.

If you specify a network view for automatic IP selection, you should also add a network_view field in the object to be inserted with the same network view because the network view for automatic IP selection is not used for the actual object insertion.

NOTE: Automatic selection is supported only for JSON and XML requests.

Examples:

  • func:nextavailableip:network/ZG54dfgsrDFEFfsfsLzA:abcd%3A%3A/64/default
  • func:nextavailableip:abcd::/64
  • func:nextavailableip:abcd::/64,external
  • func:nextavailableip:abcd::20-abcd::30

This field can also be retrieved from a function call as part of an object insertion. The supported function calls for this field are:

To find out if the function can be called when _object_parameters matches multiple objects, see the function documentation.

The default parameters are passed to the specified function call and can be overridden by passing different values for the same parameter in _parameters.

To execute the function call, a dictionary must be set in this field with the following parameters:

Mandatory Name Comment
Y _object_function The name of the function.
Y _result_field The field in which the function returns its result.
See comment _object The WAPI object type on which the function calls. Either _object or _object_ref must be set.
See comment _object_ref A WAPI object reference on which the function calls. Either _object or _object_ref must be set.
N _parameters The parameters to be passed to the function.
See comment _object_parameters The parameters used for the object search, mandatory if _object is set.

As part of the insertion, the object identified by _object and _object_parameters will be fetched, and the function identified by _object_function will be called with the parameters specified in _parameters. The result of this function will be retrieved and the field of this function specified in _result_field will be extracted and used as the value for this field.

Note that if the function call returns a list, and the field requires a single value, the first value on the list will be used.

The following example uses a value for the ‘next_available_ip’ field in the 9.0.0.0/8 network, excluding IP addresses 9.0.0.1 and 9.0.0.2:

{
    '_object_function': 'next_available_ip',
    '_parameters': {
        'exclude': ['9.0.0.1', '9.0.0.2'],
    },
    '_result_field': 'ips',
    '_object': 'network',
    '_object_parameters': {
        'network': '9.0.0.0/8',
        'network_view': 'newdefaultnv',
    }
}

Note this function call might not be valid for this particular field, this is just an example.

Create

Field ipv6addr is required if address_type is ADDRESS or BOTH.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

The ipv6addr is part of the base object.

ipv6prefix

ipv6prefix

The IPv6 Address prefix of the DHCP IPv6 Host Address object.

Type

String.

Create

The prefix is required if address_type is PREFIX or BOTH.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

ipv6prefix_bits

ipv6prefix_bits

Prefix bits of the DHCP IPv6 Host Address object.

Type

Unsigned integer.

Create

The prefix_bits is required if address_type is PREFIX or BOTH.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

last_queried

last_queried

The time of the last DNS query in Epoch seconds format.

Type

Timestamp.

Search

The field is not available for search.

Notes

The last_queried cannot be updated.

last_queried cannot be written.

match_client

match_client

Set this to ‘DUID’ to assign the IP address to the selected host, provided that the DUID of the requesting host matches the DUID that you specify in the field.

Set this to ‘RESERVED’ to reserve this particular IP address for future use, or if the IP address is statically configured on a system (the Infoblox server does not assign the address from a DHCP request).

Type

String.

Create

The default value is DUID.

Search

The field is not available for search.

ms_ad_user_data

ms_ad_user_data

The Microsoft Active Directory user related information.

Type

A/An Active Directory User Data struct.

Search

The field is not available for search.

Notes

The ms_ad_user_data cannot be updated.

ms_ad_user_data cannot be written.

network

network

The network of the host address, in FQDN/CIDR format.

Type

String.

Search

The field is not available for search.

Notes

The network cannot be updated.

network cannot be written.

network_view

network_view

The name of the network view in which the host address resides.

Type

String.

Values with leading or trailing white space are not valid for this field.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

The network_view cannot be updated.

network_view cannot be written.

options

options

An array of DHCP option structs that lists the DHCP options associated with the object.

Type

A/An DHCP option struct array.

Create

The default value is:

[ { 'name': 'dhcp-lease-time',
'num': 51,
'use_option': False,
'value': '43200',
'vendor_class': 'DHCP'}]

Search

The field is not available for search.

Notes

options is associated with the field use_options (see use flag).

preferred_lifetime

preferred_lifetime

Use this method to set or retrieve the preferred lifetime value of the DHCP IPv6 Host Address object.

Type

Unsigned integer.

Create

The default value is 27000.

Search

The field is not available for search.

Notes

preferred_lifetime is associated with the field use_preferred_lifetime (see use flag).

reserved_interface

reserved_interface

The reference to the reserved interface to which the device belongs.

Type

String.

This field supports nested return fields as described here.

Create

The default value is empty.

Search

The field is not available for search.

use_domain_name

use_domain_name

Use flag for: domain_name

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_domain_name_servers

use_domain_name_servers

Use flag for: domain_name_servers

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_for_ea_inheritance

use_for_ea_inheritance

Set this to True when using this host address for EA inheritance.

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_options

use_options

Use flag for: options

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_preferred_lifetime

use_preferred_lifetime

Use flag for: preferred_lifetime

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

use_valid_lifetime

use_valid_lifetime

Use flag for: valid_lifetime

Type

Bool.

Create

The default value is False.

Search

The field is not available for search.

valid_lifetime

valid_lifetime

Use this method to set or retrieve the valid lifetime value of the DHCP IPv6 Host Address object.

Type

Unsigned integer.

Create

The default value is 43200.

Search

The field is not available for search.

Notes

valid_lifetime is associated with the field use_valid_lifetime (see use flag).

Search-only Fields

These fields are used only for searching. They are not actual members of the object and therefore the server does not return these fields with this name unless they are nested return fields.

discovered_data.ap_ip_address

discovered_data.ap_ip_address

Discovered IP address of Wireless Access Point.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.ap_ip_address is a search-only field.

discovered_data.ap_name

discovered_data.ap_name

Discovered name of Wireless Access Point.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.ap_name is a search-only field.

discovered_data.ap_ssid

discovered_data.ap_ssid

Service set identifier (SSID) associated with Wireless Access Point.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.ap_ssid is a search-only field.

discovered_data.bgp_as

discovered_data.bgp_as

The BGP autonomous system number.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.bgp_as is a search-only field.

discovered_data.bridge_domain

discovered_data.bridge_domain

Discovered bridge domain.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.bridge_domain is a search-only field.

discovered_data.cisco_ise_endpoint_profile

discovered_data.cisco_ise_endpoint_profile

The Cisco ISE Endpoint Profile.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.cisco_ise_endpoint_profile is a search-only field.

discovered_data.cisco_ise_security_group

discovered_data.cisco_ise_security_group

The Cisco ISE security group name.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.cisco_ise_security_group is a search-only field.

discovered_data.cisco_ise_session_state

discovered_data.cisco_ise_session_state

The Cisco ISE session state.

Type

String.

Valid values are:
  • AUTHENTICATED
  • AUTHENTICATING
  • DISCONNECTED
  • POSTURED
  • STARTED

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.cisco_ise_session_state is a search-only field.

discovered_data.cisco_ise_ssid

discovered_data.cisco_ise_ssid

The Cisco ISE SSID.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.cisco_ise_ssid is a search-only field.

discovered_data.cmp_type

discovered_data.cmp_type
If the IP is coming from a Cloud environment, the Cloud Management
Platform type.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.cmp_type is a search-only field.

discovered_data.device_contact

discovered_data.device_contact

Contact information from device on which the IP address was discovered.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.device_contact is a search-only field.

discovered_data.device_location

discovered_data.device_location

Location of device on which the IP address was discovered.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.device_location is a search-only field.

discovered_data.device_model

discovered_data.device_model

The model name of the end device in the vendor terminology.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.device_model is a search-only field.

discovered_data.device_port_name

discovered_data.device_port_name

The system name of the interface associated with the discovered IP address.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.device_port_name is a search-only field.

discovered_data.device_port_type

discovered_data.device_port_type

The hardware type of the interface associated with the discovered IP address.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.device_port_type is a search-only field.

discovered_data.device_type

discovered_data.device_type

The type of end host in vendor terminology.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.device_type is a search-only field.

discovered_data.device_vendor

discovered_data.device_vendor

The vendor name of the end host.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.device_vendor is a search-only field.

discovered_data.discovered_name

discovered_data.discovered_name

The name of the network device associated with the discovered IP address.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.discovered_name is a search-only field.

discovered_data.discoverer

discovered_data.discoverer

Specifies whether the IP address was discovered by a NetMRI or NIOS discovery process.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.discoverer is a search-only field.

discovered_data.duid

discovered_data.duid

For IPv6 address only. The DHCP unique identifier of the discovered host. This is an optional field, and data might not be included.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.duid is a search-only field.

discovered_data.endpoint_groups

discovered_data.endpoint_groups

A comma-separated list of discovered endpoint groups.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.endpoint_groups is a search-only field.

discovered_data.first_discovered

discovered_data.first_discovered

The date and time the IP address was first discovered in Epoch seconds format.

Type

Timestamp.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.first_discovered is a search-only field.

discovered_data.iprg_no

discovered_data.iprg_no

The port redundant group number.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.iprg_no is a search-only field.

discovered_data.iprg_state

discovered_data.iprg_state

The status for the IP address within port redundant group.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.iprg_state is a search-only field.

discovered_data.iprg_type

discovered_data.iprg_type

The port redundant group type.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.iprg_type is a search-only field.

discovered_data.last_discovered

discovered_data.last_discovered

The date and time the IP address was last discovered in Epoch seconds format.

Type

Timestamp.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.last_discovered is a search-only field.

discovered_data.mac_address

discovered_data.mac_address

The discovered MAC address for the host. This is the unique identifier of a network device. The discovery acquires the MAC address for hosts that are located on the same network as the Grid member that is running the discovery. This can also be the MAC address of a virtual entity on a specified vSphere server.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.mac_address is a search-only field.

discovered_data.mgmt_ip_address

discovered_data.mgmt_ip_address

The management IP address of the end host that has more than one IP.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.mgmt_ip_address is a search-only field.

discovered_data.netbios_name

discovered_data.netbios_name

The name returned in the NetBIOS reply or the name you manually register for the discovered host.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.netbios_name is a search-only field.

discovered_data.network_component_contact

discovered_data.network_component_contact

Contact information from network component on which the IP address was discovered.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_contact is a search-only field.

discovered_data.network_component_description

discovered_data.network_component_description

A textual description of the switch that is connected to the end device.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_description is a search-only field.

discovered_data.network_component_ip

discovered_data.network_component_ip

The IPv4 Address or IPv6 Address of the switch that is connected to the end device.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_ip is a search-only field.

discovered_data.network_component_location

discovered_data.network_component_location

Location of network component on which the IP address was discovered.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_location is a search-only field.

discovered_data.network_component_model

discovered_data.network_component_model

Model name of the switch port connected to the end device in the vendor terminology.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_model is a search-only field.

discovered_data.network_component_name

discovered_data.network_component_name

If a reverse lookup was successful for the IP address associated with this switch, the host name is displayed here.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_name is a search-only field.

discovered_data.network_component_port_description

discovered_data.network_component_port_description

A textual description of the switch port that is connected to the end device.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_port_description is a search-only field.

discovered_data.network_component_port_name

discovered_data.network_component_port_name

The name of the switch port connected to the end device.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_port_name is a search-only field.

discovered_data.network_component_port_number

discovered_data.network_component_port_number

The number of the switch port connected to the end device.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.network_component_port_number is a search-only field.

discovered_data.network_component_type

discovered_data.network_component_type

Identifies the switch that is connected to the end device.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_type is a search-only field.

discovered_data.network_component_vendor

discovered_data.network_component_vendor

The vendor name of the switch port connected to the end host.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.network_component_vendor is a search-only field.

discovered_data.open_ports

discovered_data.open_ports

The list of opened ports on the IP address, represented as: “TCP: 21,22,23 UDP: 137,139”. Limited to max total 1000 ports.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.open_ports is a search-only field.

discovered_data.os

discovered_data.os

The operating system of the detected host or virtual entity. The OS can be one of the following:

  • Microsoft for all discovered hosts that have a non-null value in the MAC addresses using the NetBIOS discovery method.
  • A value that a TCP discovery returns.
  • The OS of a virtual entity on a vSphere server.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.os is a search-only field.

discovered_data.port_duplex

discovered_data.port_duplex

The negotiated or operational duplex setting of the switch port connected to the end device.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.port_duplex is a search-only field.

discovered_data.port_speed

discovered_data.port_speed

The interface speed, in Mbps, of the switch port.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.port_speed is a search-only field.

discovered_data.port_status

discovered_data.port_status

The operational status of the switch port. Indicates whether the port is up or down.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.port_status is a search-only field.

discovered_data.port_type

discovered_data.port_type

The type of switch port.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.port_type is a search-only field.

discovered_data.port_vlan_description

discovered_data.port_vlan_description

The description of the VLAN of the switch port that is connected to the end device.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.port_vlan_description is a search-only field.

discovered_data.port_vlan_name

discovered_data.port_vlan_name

The name of the VLAN of the switch port.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.port_vlan_name is a search-only field.

discovered_data.port_vlan_number

discovered_data.port_vlan_number

The ID of the VLAN of the switch port.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.port_vlan_number is a search-only field.

discovered_data.task_name

discovered_data.task_name

The name of the discovery task.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.task_name is a search-only field.

discovered_data.tenant

discovered_data.tenant

Discovered tenant.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.tenant is a search-only field.

discovered_data.v_adapter

discovered_data.v_adapter

The name of the physical network adapter through which the virtual entity is connected to the appliance.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.v_adapter is a search-only field.

discovered_data.v_cluster

discovered_data.v_cluster

The name of the VMware cluster to which the virtual entity belongs.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.v_cluster is a search-only field.

discovered_data.v_datacenter

discovered_data.v_datacenter

The name of the vSphere datacenter or container to which the virtual entity belongs.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.v_datacenter is a search-only field.

discovered_data.v_entity_name

discovered_data.v_entity_name

The name of the virtual entity.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.v_entity_name is a search-only field.

discovered_data.v_entity_type

discovered_data.v_entity_type

The virtual entity type. This can be blank or one of the following: Virtual Machine, Virtual Host, or Virtual Center. Virtual Center represents a VMware vCenter server.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.v_entity_type is a search-only field.

discovered_data.v_host

discovered_data.v_host

The name of the VMware server on which the virtual entity was discovered.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.v_host is a search-only field.

discovered_data.v_switch

discovered_data.v_switch

The name of the switch to which the virtual entity is connected.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.v_switch is a search-only field.

discovered_data.vlan_port_group

discovered_data.vlan_port_group

Port group which the virtual machine belongs to.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vlan_port_group is a search-only field.

discovered_data.vmhost_ip_address

discovered_data.vmhost_ip_address
IP address of the physical node on which the virtual machine is
hosted.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vmhost_ip_address is a search-only field.

discovered_data.vmhost_mac_address

discovered_data.vmhost_mac_address
MAC address of the physical node on which the virtual machine is
hosted.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vmhost_mac_address is a search-only field.

discovered_data.vmhost_name

discovered_data.vmhost_name
Name of the physical node on which the virtual machine is
hosted.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vmhost_name is a search-only field.

discovered_data.vmhost_nic_names

discovered_data.vmhost_nic_names
List of all physical port names used by the virtual switch on the
physical node on which the virtual machine is hosted. Represented as: “eth1,eth2,eth3”.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vmhost_nic_names is a search-only field.

discovered_data.vmhost_subnet_cidr

discovered_data.vmhost_subnet_cidr
CIDR subnet of the physical node on which the virtual machine
is hosted.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.vmhost_subnet_cidr is a search-only field.

discovered_data.vmi_id

discovered_data.vmi_id

ID of the virtual machine.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vmi_id is a search-only field.

discovered_data.vmi_ip_type

discovered_data.vmi_ip_type

Discovered IP address type.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vmi_ip_type is a search-only field.

discovered_data.vmi_is_public_address

discovered_data.vmi_is_public_address

Indicates whether the IP address is a public address.

Type

Bool.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vmi_is_public_address is a search-only field.

discovered_data.vmi_name

discovered_data.vmi_name

Name of the virtual machine.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vmi_name is a search-only field.

discovered_data.vmi_private_address

discovered_data.vmi_private_address

Private IP address of the virtual machine.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vmi_private_address is a search-only field.

discovered_data.vmi_tenant_id

discovered_data.vmi_tenant_id

ID of the tenant which virtual machine belongs to.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vmi_tenant_id is a search-only field.

discovered_data.vport_conf_mode

discovered_data.vport_conf_mode
Configured mode of the network adapter on the virtual switch
where the virtual machine connected to.

Type

String.

Valid values are:
  • Full-duplex
  • Half-duplex
  • Unknown

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vport_conf_mode is a search-only field.

discovered_data.vport_conf_speed

discovered_data.vport_conf_speed
Configured speed of the network adapter on the virtual switch
where the virtual machine connected to. Unit is kb.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.vport_conf_speed is a search-only field.

discovered_data.vport_mac_address

discovered_data.vport_mac_address
MAC address of the network adapter on the virtual switch where the
virtual machine connected to.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vport_mac_address is a search-only field.

discovered_data.vport_mode

discovered_data.vport_mode
Actual mode of the network adapter on the virtual switch where
the virtual machine connected to.

Type

String.

Valid values are:
  • Full-duplex
  • Half-duplex
  • Unknown

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vport_mode is a search-only field.

discovered_data.vport_name

discovered_data.vport_name
Name of the network adapter on the virtual switch connected with
the virtual machine.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vport_name is a search-only field.

discovered_data.vport_speed

discovered_data.vport_speed
Actual speed of the network adapter on the virtual switch where
the virtual machine connected to. Unit is kb.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.vport_speed is a search-only field.

discovered_data.vrf_description

discovered_data.vrf_description

Description of the VRF.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vrf_description is a search-only field.

discovered_data.vrf_name

discovered_data.vrf_name

The name of the VRF.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vrf_name is a search-only field.

discovered_data.vrf_rd

discovered_data.vrf_rd

Route distinguisher of the VRF.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vrf_rd is a search-only field.

discovered_data.vswitch_available_ports_count

discovered_data.vswitch_available_ports_count
Numer of available ports reported by the virtual switch on
which the virtual machine/vport connected to.

Type

Unsigned integer.

Search

The field is available for search via

  • ‘!=’ (negative search)
  • ‘=’ (exact equality)
  • ‘<=’ (less than search)
  • ‘>=’ (greater than search)

Notes

discovered_data.vswitch_available_ports_count is a search-only field.

discovered_data.vswitch_id

discovered_data.vswitch_id

ID of the virtual switch.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vswitch_id is a search-only field.

discovered_data.vswitch_ipv6_enabled

discovered_data.vswitch_ipv6_enabled

Indicates the virtual switch has IPV6 enabled.

Type

Bool.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vswitch_ipv6_enabled is a search-only field.

discovered_data.vswitch_name

discovered_data.vswitch_name

Name of the virtual switch.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_name is a search-only field.

discovered_data.vswitch_segment_id

discovered_data.vswitch_segment_id
ID of the network segment on which the current virtual
machine/vport connected to.

Type

String.

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vswitch_segment_id is a search-only field.

discovered_data.vswitch_segment_name

discovered_data.vswitch_segment_name
Name of the network segment on which the current virtual
machine/vport connected to.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_segment_name is a search-only field.

discovered_data.vswitch_segment_port_group

discovered_data.vswitch_segment_port_group
Port group of the network segment on which the current virtual
machine/vport connected to.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_segment_port_group is a search-only field.

discovered_data.vswitch_segment_type

discovered_data.vswitch_segment_type
Type of the network segment on which the current virtual
machine/vport connected to.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_segment_type is a search-only field.

discovered_data.vswitch_tep_dhcp_server

discovered_data.vswitch_tep_dhcp_server
DHCP server of the virtual tunnel endpoint (VTEP) in the virtual
switch.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_tep_dhcp_server is a search-only field.

discovered_data.vswitch_tep_ip

discovered_data.vswitch_tep_ip
IP address of the virtual tunnel endpoint (VTEP) in the virtual
switch.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_tep_ip is a search-only field.

discovered_data.vswitch_tep_multicast

discovered_data.vswitch_tep_multicast
Muticast address of the virtual tunnel endpoint (VTEP) in the
virtual swtich.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_tep_multicast is a search-only field.

discovered_data.vswitch_tep_port_group

discovered_data.vswitch_tep_port_group
Port group of the virtual tunnel endpoint (VTEP) in the virtual
switch.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_tep_port_group is a search-only field.

discovered_data.vswitch_tep_type

discovered_data.vswitch_tep_type

Type of virtual tunnel endpoint (VTEP) in the virtual switch.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_tep_type is a search-only field.

discovered_data.vswitch_tep_vlan

discovered_data.vswitch_tep_vlan
VLAN of the virtual tunnel endpoint (VTEP) in the virtual
switch.

Type

String.

Search

The field is available for search via

  • ‘:=’ (case insensitive search)
  • ‘=’ (exact equality)
  • ‘~=’ (regular expression)

Notes

discovered_data.vswitch_tep_vlan is a search-only field.

discovered_data.vswitch_type

discovered_data.vswitch_type

Type of the virtual switch: standard or distributed.

Type

String.

Valid values are:
  • Distributed
  • Standard
  • Unknown

Search

The field is available for search via

  • ‘=’ (exact equality)

Notes

discovered_data.vswitch_type is a search-only field.

Fields List

Field Type Req R/O Base Search
address_type String N N N N/A
configure_for_dhcp Bool N N Y N/A
discover_now_status String N Y N N/A
discovered_data struct N Y N N/A
domain_name String N N N N/A
domain_name_servers [String] N N N N/A
duid String N N Y : = ~
host String N Y Y N/A
ipv6addr String Y* N Y = ~
ipv6prefix String Y* N N = ~
ipv6prefix_bits Unsigned int Y* N N < = >
last_queried Timestamp N Y N N/A
match_client String N N N N/A
ms_ad_user_data struct N Y N N/A
network String N Y N N/A
network_view String N Y N =
options [struct] N N N N/A
preferred_lifetime Unsigned int N N N N/A
reserved_interface String N N N N/A
use_domain_name Bool N N N N/A
use_domain_name_servers Bool N N N N/A
use_for_ea_inheritance Bool N N N N/A
use_options Bool N N N N/A
use_preferred_lifetime Bool N N N N/A
use_valid_lifetime Bool N N N N/A
valid_lifetime Unsigned int N N N N/A

* Required in some cases, see detailed field description above.

Search-only Fields List

Field Type Search
discovered_data.ap_ip_address String : = ~
discovered_data.ap_name String : = ~
discovered_data.ap_ssid String : = ~
discovered_data.bgp_as Unsigned int ! < = >
discovered_data.bridge_domain String : = ~
discovered_data.cisco_ise_endpoint_profile String : = ~
discovered_data.cisco_ise_security_group String : = ~
discovered_data.cisco_ise_session_state String =
discovered_data.cisco_ise_ssid String : = ~
discovered_data.cmp_type String : = ~
discovered_data.device_contact String : = ~
discovered_data.device_location String : = ~
discovered_data.device_model String : = ~
discovered_data.device_port_name String : = ~
discovered_data.device_port_type String : = ~
discovered_data.device_type String : = ~
discovered_data.device_vendor String : = ~
discovered_data.discovered_name String : = ~
discovered_data.discoverer String : = ~
discovered_data.duid String : = ~
discovered_data.endpoint_groups String : = ~
discovered_data.first_discovered Timestamp ! < = >
discovered_data.iprg_no Unsigned int ! < = >
discovered_data.iprg_state String =
discovered_data.iprg_type String =
discovered_data.last_discovered Timestamp ! < = >
discovered_data.mac_address String : = ~
discovered_data.mgmt_ip_address String : = ~
discovered_data.netbios_name String : = ~
discovered_data.network_component_contact String : = ~
discovered_data.network_component_description String : = ~
discovered_data.network_component_ip String = ~
discovered_data.network_component_location String : = ~
discovered_data.network_component_model String : = ~
discovered_data.network_component_name String : = ~
discovered_data.network_component_port_description String : = ~
discovered_data.network_component_port_name String : = ~
discovered_data.network_component_port_number Unsigned int ! < = >
discovered_data.network_component_type String : = ~
discovered_data.network_component_vendor String : = ~
discovered_data.open_ports String : = ~
discovered_data.os String : = ~
discovered_data.port_duplex String =
discovered_data.port_link_status String =
discovered_data.port_speed String =
discovered_data.port_status String =
discovered_data.port_type String : = ~
discovered_data.port_vlan_description String : = ~
discovered_data.port_vlan_name String : = ~
discovered_data.port_vlan_number Unsigned int ! < = >
discovered_data.task_name String : = ~
discovered_data.tenant String : = ~
discovered_data.v_adapter String : = ~
discovered_data.v_cluster String : = ~
discovered_data.v_datacenter String : = ~
discovered_data.v_entity_name String : = ~
discovered_data.v_entity_type String =
discovered_data.v_host String : = ~
discovered_data.v_switch String : = ~
discovered_data.vlan_port_group String : = ~
discovered_data.vmhost_ip_address String : = ~
discovered_data.vmhost_mac_address String : = ~
discovered_data.vmhost_name String : = ~
discovered_data.vmhost_nic_names String : = ~
discovered_data.vmhost_subnet_cidr Unsigned int ! < = >
discovered_data.vmi_id String =
discovered_data.vmi_ip_type String : = ~
discovered_data.vmi_is_public_address Bool =
discovered_data.vmi_name String : = ~
discovered_data.vmi_private_address String : = ~
discovered_data.vmi_tenant_id String =
discovered_data.vport_conf_mode String =
discovered_data.vport_conf_speed Unsigned int ! < = >
discovered_data.vport_link_status String : = ~
discovered_data.vport_mac_address String : = ~
discovered_data.vport_mode String =
discovered_data.vport_name String : = ~
discovered_data.vport_speed Unsigned int ! < = >
discovered_data.vrf_description String : = ~
discovered_data.vrf_name String : = ~
discovered_data.vrf_rd String = ~
discovered_data.vswitch_available_ports_count Unsigned int ! < = >
discovered_data.vswitch_id String =
discovered_data.vswitch_ipv6_enabled Bool =
discovered_data.vswitch_name String : = ~
discovered_data.vswitch_segment_id String =
discovered_data.vswitch_segment_name String : = ~
discovered_data.vswitch_segment_port_group String : = ~
discovered_data.vswitch_segment_type String : = ~
discovered_data.vswitch_tep_dhcp_server String : = ~
discovered_data.vswitch_tep_ip String : = ~
discovered_data.vswitch_tep_multicast String : = ~
discovered_data.vswitch_tep_port_group String : = ~
discovered_data.vswitch_tep_type String : = ~
discovered_data.vswitch_tep_vlan String : = ~
discovered_data.vswitch_type String =

Table Of Contents

Previous topic

record:host_ipv4addr : IPv4 Host address object.

Next topic

record:mx : DNS MX record object.