A fixed address is a specific IP address that a DHCP server always assigns when a lease request comes from a particular MAC address of the client.
References to fixedaddress are object references.
The name part of a DHCP Fixed Address object reference has the following components:
- IP address of the fixed address
- Name of the view
Example: fixedaddress/ZG5zLmJpbmRfY25h:12.0.10.1/external
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): ipv4addr, network_view.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| agent_circuit_id | See the field description for more information |
| agent_remote_id | See the field description for more information |
| dhcp_client_identifier | See the field description for more information |
| ipv4addr | |
| mac | See the field description for more information |
The agent circuit ID for the fixed address.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required only when match_client is set to CIRCUIT_ID.
Search
The field is not available for search.
The agent remote ID for the fixed address.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required only when match_client is set to REMOTE_ID.
Search
The field is not available for search.
This field controls whether the credential is used for both the Telnet and SSH credentials. If set to False, the credential is used only for SSH.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
This field controls whether only the DHCP server is allowed to update DNS, regardless of the DHCP client requests.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The bootfile name for the fixed address. You can configure the DHCP server to support clients that use the boot file name option in their DHCPREQUEST messages.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
bootfile is associated with the field use_bootfile (see use flag).
The bootserver address for the fixed address. You can specify the name and/or IP address of the boot server that the host needs to boot.
The boot server IPv4 Address or name in FQDN format.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
bootserver is associated with the field use_bootserver (see use flag).
The CLI credentials for the fixed address.
Type
A/An CLI credential struct array.
Create
The default value is empty.
Search
The field is not available for search.
This field controls whether there is a prepend for the dhcp-client-identifier of a fixed address.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Structure containing all cloud API related information for this object.
Type
A/An Cloud Information struct.
Search
The field is not available for search.
Notes
The cloud_info cannot be updated.
cloud_info cannot be written.
Comment for the fixed address; maximum 256 characters.
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
The dynamic DNS domain name the appliance uses specifically for DDNS updates for this fixed address.
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
ddns_domainname is associated with the field use_ddns_domainname (see use flag).
The DDNS host name for this fixed address.
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.
If set to true, BOOTP settings are disabled and BOOTP requests will be denied.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
deny_bootp is associated with the field use_deny_bootp (see use flag).
The description of the device.
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
The location of the device.
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
The type of the device.
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
The vendor of the device.
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
The DHCP client ID for the fixed address.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required only when match_client is set to CLIENT_ID.
Search
The field is not available for search.
Determines whether a fixed address is disabled or not. When this is set to False, the fixed address is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Determines if the discovery for this fixed address is disabled or not. False means that the discovery is enabled.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The discovery status of this fixed 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 fixed 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.
The dynamic DNS updates flag of a DHCP Fixed Address object. If set to True, the DHCP server sends DDNS updates to DNS servers in the same Grid, and to external DNS servers.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
enable_ddns is associated with the field use_enable_ddns (see use flag).
Determines if the discovery for the fixed address should be immediately enabled.
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
enable_immediate_discovery is not readable.
Set this to True if you want the DHCP server to use a different lease time for PXE clients.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
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.
If this field is set to False, the appliance returns all DHCP options the client is eligible to receive, rather than only the list of options the client has requested.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
ignore_dhcp_option_list_request is associated with the field use_ignore_dhcp_option_list_request (see use flag).
The IPv4 Address of the fixed address.
Type
String.
The field also supports automatic selection of the next available address in the specified network or range. You can specify the network or range in the following ways:
Using a network or range WAPI reference:
- func:nextavailableip:<reference>
Using a network lookup (if the view is not specified, the default view will be used):
- func:nextavailableip:<network>[,<network view>]
Using a 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:10.0.0.0/8/default
- func:nextavailableip:10.0.0.0/8
- func:nextavailableip:10.0.0.0/8,external
- func:nextavailableip:10.0.0.3-10.0.0.10
This field can also be retrieved from a function call as part of an object insertion. The supported function calls for this field are:
- the next_available_ip function call in object range (default parameters: {‘num’: 1})
- the next_available_ip function call in object network (default parameters: {‘num’: 1})
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
The field is required on creation.
Search
The field is available for search via
Notes
The ipv4addr is part of the base object.
This flag reflects whether the MAC address for this fixed address is invalid.
Type
Bool.
Search
The field is not available for search.
Notes
The is_invalid_mac cannot be updated.
is_invalid_mac cannot be written.
This field contains the logic filters to be applied on the this fixed address.
This list corresponds to the match rules that are written to the dhcpd configuration file.
Type
A/An Logic Filter rule struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
logic_filter_rules is associated with the field use_logic_filter_rules (see use flag).
The MAC address value for this fixed address.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The field is required only when match_client is set to its default value - MAC_ADDRESS.
Search
The field is available for search via
The match_client value for this fixed address. Valid values are:
“MAC_ADDRESS”: The fixed IP address is leased to the matching MAC address.
“CLIENT_ID”: The fixed IP address is leased to the matching DHCP client identifier.
“RESERVED”: The fixed IP address is reserved for later use with a MAC address that only has zeros.
“CIRCUIT_ID”: The fixed IP address is leased to the DHCP client with a matching circuit ID. Note that the “agent_circuit_id” field must be set in this case.
“REMOTE_ID”: The fixed IP address is leased to the DHCP client with a matching remote ID. Note that the “agent_remote_id” field must be set in this case.
Type
String.
Create
The default value is MAC_ADDRESS.
Search
The field is available for search via
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.
This field contains the Microsoft DHCP options for this fixed address.
Type
A/An Microsoft DHCP Options struct array.
Create
The default value is:
empty
Search
The field is not available for search.
Notes
ms_options is associated with the field use_ms_options (see use flag).
The Microsoft server associated with this fixed address.
Type
A/An MS DHCP server struct.
Create
The default value is empty.
Search
The field is available for search via
This field contains the name of this fixed address.
Type
String.
Values with leading or trailing white space are not valid for this field.
Create
The default value is empty.
Search
The field is not available for search.
The network to which this fixed address belongs, in IPv4 Address/CIDR format.
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
The name of the network view in which this fixed address resides.
Type
String.
Create
The default value is The default network view.
Search
The field is available for search via
Notes
The network_view is part of the base object.
The name in FQDN and/or IPv4 Address format of the next server that the host needs to boot.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
nextserver is associated with the field use_nextserver (see use flag).
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).
The PXE lease time value for a DHCP Fixed Address object. Some hosts use PXE (Preboot Execution Environment) to boot remotely from a server. To better manage your IP resources, set a different lease time for PXE boot requests. You can configure the DHCP server to allocate an IP address with a shorter lease time to hosts that send PXE boot requests, so IP addresses are not leased longer than necessary.
A 32-bit unsigned integer that represents the duration, in seconds, for which the update is cached. Zero indicates that the update is not cached.
Type
Unsigned integer.
Create
The default value is empty.
Search
The field is not available for search.
Notes
pxe_lease_time is associated with the field use_pxe_lease_time (see use flag).
The ref 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.
Restarts the member service. The restart_if_needed flag can trigger a restart on DHCP services only when it is enabled on CP member.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Notes
restart_if_needed is not readable.
The SNMPv3 credential for this fixed address.
Type
A/An SNMP v3 Credential struct.
Create
The default value is empty.
Search
The field is not available for search.
The SNMPv1 or SNMPv2 credential for this fixed address.
Type
A/An SNMP Credential struct.
Create
The default value is empty.
Search
The field is not available for search.
If set on creation, the fixed address will be created according to the values specified in the named template.
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Notes
The template cannot be updated.
template is not readable.
Use flag for: bootfile
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: bootserver
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
If set to true, the CLI credential will override member-level settings.
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ddns_domainname
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: deny_bootp
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: enable_ddns
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ignore_dhcp_option_list_request
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: logic_filter_rules
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: ms_options
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: nextserver
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: options
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Use flag for: pxe_lease_time
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
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 |
|---|---|---|---|---|---|
| agent_circuit_id | String | Y* | N | N | N/A |
| agent_remote_id | String | Y* | N | N | N/A |
| allow_telnet | Bool | N | N | N | N/A |
| always_update_dns | Bool | N | N | N | N/A |
| bootfile | String | N | N | N | N/A |
| bootserver | String | N | N | N | N/A |
| cli_credentials | [struct] | N | N | N | N/A |
| client_identifier_prepend_zero | Bool | N | N | N | N/A |
| cloud_info | struct | N | Y | N | N/A |
| comment | String | N | N | N | : = ~ |
| ddns_domainname | String | N | N | N | N/A |
| ddns_hostname | String | N | N | N | N/A |
| deny_bootp | Bool | N | N | N | N/A |
| device_description | String | N | N | N | : = ~ |
| device_location | String | N | N | N | : = ~ |
| device_type | String | N | N | N | : = ~ |
| device_vendor | String | N | N | N | : = ~ |
| dhcp_client_identifier | String | Y* | N | N | N/A |
| disable | Bool | N | N | N | N/A |
| disable_discovery | Bool | N | N | N | N/A |
| discover_now_status | String | N | Y | N | N/A |
| discovered_data | struct | N | Y | N | N/A |
| enable_ddns | Bool | N | N | N | N/A |
| enable_immediate_discovery | Bool | N | N | N | N/A |
| enable_pxe_lease_time | Bool | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| ipv4addr | String | Y | N | Y | = ~ |
| is_invalid_mac | Bool | N | Y | N | N/A |
| logic_filter_rules | [struct] | N | N | N | N/A |
| mac | String | Y* | N | N | : = ~ |
| match_client | String | N | N | N | = |
| ms_ad_user_data | struct | N | Y | N | N/A |
| ms_options | [struct] | N | N | N | N/A |
| ms_server | struct | N | N | N | = |
| name | String | N | N | N | N/A |
| network | String | N | N | N | = ~ |
| network_view | String | N | N | Y | = |
| nextserver | String | N | N | N | N/A |
| options | [struct] | N | N | N | N/A |
| pxe_lease_time | Unsigned int | N | N | N | N/A |
| reserved_interface | String | N | N | N | N/A |
| restart_if_needed | Bool | N | N | N | N/A |
| snmp3_credential | struct | N | N | N | N/A |
| snmp_credential | struct | N | N | N | N/A |
| template | String | N | N | N | N/A |
| use_bootfile | Bool | N | N | N | N/A |
| use_bootserver | Bool | N | N | N | N/A |
| use_cli_credentials | Bool | N | N | N | N/A |
| use_ddns_domainname | Bool | N | N | N | N/A |
| use_deny_bootp | Bool | N | N | N | N/A |
| use_enable_ddns | Bool | N | N | N | N/A |
| use_ignore_dhcp_option_list_request | Bool | N | N | N | N/A |
| use_logic_filter_rules | Bool | N | N | N | N/A |
| use_ms_options | Bool | N | N | N | N/A |
| use_nextserver | Bool | N | N | N | N/A |
| use_options | Bool | N | N | N | N/A |
| use_pxe_lease_time | Bool | N | N | N | N/A |
| use_snmp3_credential | Bool | N | N | N | N/A |
| use_snmp_credential | Bool | N | N | N | N/A |
* Required in some cases, see detailed field description above.
| 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 | = |
fingerprint : DHCP Fingerprint object.