This object is created only as part of the record.host object, it cannot be created directly.
References to ipv6address are object references. The name part of an ipv6address object reference has the following components:
- IP address
- Name of the network view
Example: ipv6address/Li5pcHY0X2FkZHJlc3MkMTAuMC4wLjEvMQ:abcd::1/external
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): duid, ip_address, is_conflict, lease_state, names, network, network_view, objects, status, types, usage.
Comment for the address; maximum 256 characters.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
Notes
The comment cannot be updated.
comment cannot be written.
Types of the conflict.
Type
Enum values array.
Search
The field is not available for search.
Notes
The conflict_types cannot be updated.
conflict_types cannot be written.
Discover now status for this address.
Type
String.
Search
The field is not available for search.
Notes
The discover_now_status cannot be updated.
discover_now_status cannot be written.
The discovered data for this 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.
DHCPv6 Unique Identifier (DUID) of the address object.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is available for search via
Notes
The duid is part of the base object.
The duid cannot be updated.
duid cannot be written.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
DHCP fingerprint for the address.
Type
String.
Search
The field is available for search via
Notes
The fingerprint cannot be updated.
fingerprint cannot be written.
IPv6 addresses of the address object.
Type
String.
Search
The field is available for search via
Notes
The ip_address is part of the base object.
The ip_address cannot be updated.
ip_address cannot be written.
IP address has either a duid conflict or a DHCP lease conflict detected through a network discovery.
Type
Bool.
Search
The field is available for search via
Notes
The is_conflict is part of the base object.
The is_conflict cannot be updated.
is_conflict cannot be written.
The lease state of the address.
Type
String.
Search
The field is available for search via
Notes
The lease_state is part of the base object.
The lease_state cannot be updated.
lease_state cannot be written.
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.
The DNS names. For example, if the IP address belongs to a host record, this field contains the hostname. This field supports both single and array search.
Type
String array.
Search
The field is available for search via
Notes
The names is part of the base object.
The names cannot be updated.
names cannot be written.
The network to which this address belongs, in FQDN/CIDR format.
Type
String.
Search
The field is available for search via
Notes
The network is part of the base object.
The network cannot be updated.
network cannot be written.
The name of the network view.
Type
String.
Search
The field is available for search via
Notes
The network_view is part of the base object.
The network_view cannot be updated.
network_view cannot be written.
The objects associated with the IP address.
Type
String.
Search
The field is not available for search.
Notes
The objects is part of the base object.
The objects cannot be updated.
objects cannot be written.
The reserved port for the address.
Type
String.
Values with leading or trailing white space are not valid for this field.
Search
The field is not available for search.
Notes
The reserved_port cannot be updated.
reserved_port cannot be written.
The current status of the address.
Type
String.
Search
The field is available for search via
Notes
The status is part of the base object.
The status cannot be updated.
status cannot be written.
The types of associated objects. This field supports both single and array search.
Type
String array.
Search
The field is available for search via
Notes
The types is part of the base object.
The types cannot be updated.
types cannot be written.
Indicates whether the IP address is configured for DNS or DHCP. This field supports both single and array search.
Type
String array.
Search
The field is available for search via
Notes
The usage is part of the base object.
The usage cannot be updated.
usage cannot be written.
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 IP address of Wireless Access Point.
Type
String.
Search
The field is available for search via
Notes
discovered_data.ap_ip_address is a search-only field.
Discovered name of Wireless Access Point.
Type
String.
Search
The field is available for search via
Notes
discovered_data.ap_name is a search-only field.
Service set identifier (SSID) associated with Wireless Access Point.
Type
String.
Search
The field is available for search via
Notes
discovered_data.ap_ssid is a search-only field.
The BGP autonomous system number.
Type
Unsigned integer.
Search
The field is available for search via
Notes
discovered_data.bgp_as is a search-only field.
Discovered bridge domain.
Type
String.
Search
The field is available for search via
Notes
discovered_data.bridge_domain is a search-only field.
The Cisco ISE Endpoint Profile.
Type
String.
Search
The field is available for search via
Notes
discovered_data.cisco_ise_endpoint_profile is a search-only field.
The Cisco ISE security group name.
Type
String.
Search
The field is available for search via
Notes
discovered_data.cisco_ise_security_group is a search-only field.
The Cisco ISE session state.
Type
String.
Search
The field is available for search via
Notes
discovered_data.cisco_ise_session_state is a search-only field.
The Cisco ISE SSID.
Type
String.
Search
The field is available for search via
Notes
discovered_data.cisco_ise_ssid is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.cmp_type is a search-only field.
Contact information from device on which the IP address was discovered.
Type
String.
Search
The field is available for search via
Notes
discovered_data.device_contact is a search-only field.
Location of device on which the IP address was discovered.
Type
String.
Search
The field is available for search via
Notes
discovered_data.device_location is a search-only field.
The model name of the end device in the vendor terminology.
Type
String.
Search
The field is available for search via
Notes
discovered_data.device_model is a search-only field.
The system name of the interface associated with the discovered IP address.
Type
String.
Search
The field is available for search via
Notes
discovered_data.device_port_name is a search-only field.
The hardware type of the interface associated with the discovered IP address.
Type
String.
Search
The field is available for search via
Notes
discovered_data.device_port_type is a search-only field.
The type of end host in vendor terminology.
Type
String.
Search
The field is available for search via
Notes
discovered_data.device_type is a search-only field.
The vendor name of the end host.
Type
String.
Search
The field is available for search via
Notes
discovered_data.device_vendor is a search-only field.
The name of the network device associated with the discovered IP address.
Type
String.
Search
The field is available for search via
Notes
discovered_data.discovered_name is a search-only field.
Specifies whether the IP address was discovered by a NetMRI or NIOS discovery process.
Type
String.
Search
The field is available for search via
Notes
discovered_data.discoverer is a search-only field.
A comma-separated list of discovered endpoint groups.
Type
String.
Search
The field is available for search via
Notes
discovered_data.endpoint_groups is a search-only field.
The date and time the IP address was first discovered in Epoch seconds format.
Type
Timestamp.
Search
The field is available for search via
Notes
discovered_data.first_discovered is a search-only field.
The port redundant group number.
Type
Unsigned integer.
Search
The field is available for search via
Notes
discovered_data.iprg_no is a search-only field.
The status for the IP address within port redundant group.
Type
String.
Search
The field is available for search via
Notes
discovered_data.iprg_state is a search-only field.
The port redundant group type.
Type
String.
Search
The field is available for search via
Notes
discovered_data.iprg_type is a search-only field.
The date and time the IP address was last discovered in Epoch seconds format.
Type
Timestamp.
Search
The field is available for search via
Notes
discovered_data.last_discovered is a search-only field.
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
Notes
discovered_data.mac_address is a search-only field.
The management IP address of the end host that has more than one IP.
Type
String.
Search
The field is available for search via
Notes
discovered_data.mgmt_ip_address is a search-only field.
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
Notes
discovered_data.netbios_name is a search-only field.
Contact information from network component on which the IP address was discovered.
Type
String.
Search
The field is available for search via
Notes
discovered_data.network_component_contact is a search-only field.
A textual description of the switch that is connected to the end device.
Type
String.
Search
The field is available for search via
Notes
discovered_data.network_component_description is a search-only field.
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
Notes
discovered_data.network_component_ip is a search-only field.
Location of network component on which the IP address was discovered.
Type
String.
Search
The field is available for search via
Notes
discovered_data.network_component_location is a search-only field.
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
Notes
discovered_data.network_component_model is a search-only field.
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
Notes
discovered_data.network_component_name is a search-only field.
A textual description of the switch port that is connected to the end device.
Type
String.
Search
The field is available for search via
Notes
discovered_data.network_component_port_description is a search-only field.
The name of the switch port connected to the end device.
Type
String.
Search
The field is available for search via
Notes
discovered_data.network_component_port_name is a search-only field.
The number of the switch port connected to the end device.
Type
Unsigned integer.
Search
The field is available for search via
Notes
discovered_data.network_component_port_number is a search-only field.
Identifies the switch that is connected to the end device.
Type
String.
Search
The field is available for search via
Notes
discovered_data.network_component_type is a search-only field.
The vendor name of the switch port connected to the end host.
Type
String.
Search
The field is available for search via
Notes
discovered_data.network_component_vendor is a search-only field.
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
Notes
discovered_data.open_ports is a search-only field.
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
Notes
discovered_data.os is a search-only field.
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
Notes
discovered_data.port_duplex is a search-only field.
The link status of the switch port connected to the end device. Indicates whether it is connected.
Type
String.
Search
The field is available for search via
Notes
discovered_data.port_link_status is a search-only field.
The interface speed, in Mbps, of the switch port.
Type
String.
Search
The field is available for search via
Notes
discovered_data.port_speed is a search-only field.
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
Notes
discovered_data.port_status is a search-only field.
The type of switch port.
Type
String.
Search
The field is available for search via
Notes
discovered_data.port_type is a search-only field.
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
Notes
discovered_data.port_vlan_description is a search-only field.
The name of the VLAN of the switch port.
Type
String.
Search
The field is available for search via
Notes
discovered_data.port_vlan_name is a search-only field.
The ID of the VLAN of the switch port.
Type
Unsigned integer.
Search
The field is available for search via
Notes
discovered_data.port_vlan_number is a search-only field.
The name of the discovery task.
Type
String.
Search
The field is available for search via
Notes
discovered_data.task_name is a search-only field.
Discovered tenant.
Type
String.
Search
The field is available for search via
Notes
discovered_data.tenant is a search-only field.
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
Notes
discovered_data.v_adapter is a search-only field.
The name of the VMware cluster to which the virtual entity belongs.
Type
String.
Search
The field is available for search via
Notes
discovered_data.v_cluster is a search-only field.
The name of the vSphere datacenter or container to which the virtual entity belongs.
Type
String.
Search
The field is available for search via
Notes
discovered_data.v_datacenter is a search-only field.
The name of the virtual entity.
Type
String.
Search
The field is available for search via
Notes
discovered_data.v_entity_name is a search-only field.
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
Notes
discovered_data.v_entity_type is a search-only field.
The name of the VMware server on which the virtual entity was discovered.
Type
String.
Search
The field is available for search via
Notes
discovered_data.v_host is a search-only field.
The name of the switch to which the virtual entity is connected.
Type
String.
Search
The field is available for search via
Notes
discovered_data.v_switch is a search-only field.
Port group which the virtual machine belongs to.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vlan_port_group is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmhost_ip_address is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmhost_mac_address is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmhost_name is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmhost_nic_names is a search-only field.
Type
Unsigned integer.
Search
The field is available for search via
Notes
discovered_data.vmhost_subnet_cidr is a search-only field.
ID of the virtual machine.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmi_id is a search-only field.
Discovered IP address type.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmi_ip_type is a search-only field.
Indicates whether the IP address is a public address.
Type
Bool.
Search
The field is available for search via
Notes
discovered_data.vmi_is_public_address is a search-only field.
Name of the virtual machine.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmi_name is a search-only field.
Private IP address of the virtual machine.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmi_private_address is a search-only field.
ID of the tenant which virtual machine belongs to.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vmi_tenant_id is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vport_conf_mode is a search-only field.
Type
Unsigned integer.
Search
The field is available for search via
Notes
discovered_data.vport_conf_speed is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vport_link_status is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vport_mac_address is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vport_mode is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vport_name is a search-only field.
Type
Unsigned integer.
Search
The field is available for search via
Notes
discovered_data.vport_speed is a search-only field.
Description of the VRF.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vrf_description is a search-only field.
The name of the VRF.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vrf_name is a search-only field.
Route distinguisher of the VRF.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vrf_rd is a search-only field.
Type
Unsigned integer.
Search
The field is available for search via
Notes
discovered_data.vswitch_available_ports_count is a search-only field.
ID of the virtual switch.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_id is a search-only field.
Indicates the virtual switch has IPV6 enabled.
Type
Bool.
Search
The field is available for search via
Notes
discovered_data.vswitch_ipv6_enabled is a search-only field.
Name of the virtual switch.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_name is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_segment_id is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_segment_name is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_segment_port_group is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_segment_type is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_tep_dhcp_server is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_tep_ip is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_tep_multicast is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_tep_port_group is a search-only field.
Type of virtual tunnel endpoint (VTEP) in the virtual switch.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_tep_type is a search-only field.
Type
String.
Search
The field is available for search via
Notes
discovered_data.vswitch_tep_vlan is a search-only field.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| comment | String | N | Y | N | : = ~ |
| conflict_types | [Enum] | N | Y | N | N/A |
| discover_now_status | String | N | Y | N | N/A |
| discovered_data | struct | N | Y | N | N/A |
| duid | String | N | Y | Y | : = ~ |
| extattrs | Extattr | N | N | N | ext |
| fingerprint | String | N | Y | N | : = ~ |
| ip_address | String | N | Y | Y | < = > |
| is_conflict | Bool | N | Y | Y | = |
| lease_state | String | N | Y | Y | : = |
| ms_ad_user_data | struct | N | Y | N | N/A |
| names | [String] | N | Y | Y | : = ~ |
| network | String | N | Y | Y | = |
| network_view | String | N | Y | Y | = |
| objects | String | N | Y | Y | N/A |
| reserved_port | String | N | Y | N | N/A |
| status | String | N | Y | Y | = |
| types | [String] | N | Y | Y | : = |
| usage | [String] | N | Y | Y | : = |
| 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.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 | = |
ipv4address : IPAM IPv4Address object.
ipv6dhcpoptiondefinition : DHCP IPv6 option definition object.
