The search object is used to perform global searches for multiple object types in the database. This object contains only search parameters and returns objects that match the search criteria. The returned objects are base objects for the respective object types.
Search is the only allowed operation for search objects.
NOTE: Only one of the following can be used each time: ‘address’, ‘mac_address’, ‘duid’ or ‘fqdn’.
search objects are search only and will not be returned. They can not be referenced.
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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.
IP address is used as the search criterion.
Type
String.
Search
The field is available for search via
Notes
address is a search-only field.
DUID is used as the search criterion.
Type
String.
Search
The field is available for search via
Notes
duid is a search-only field.
FQDN is used as the search criterion.
Type
String.
Search
The field is available for search via
Notes
fqdn is a search-only field.
MAC address is used as the search criterion.
Type
String.
Search
The field is available for search via
Notes
mac_address is a search-only field.
Type of object to search for. If not specified, all object types will be searched.
Type
String.
Search
The field is available for search via
Notes
objtype is a search-only field.
Pattern to search for. In most cases, using regular expression (~=) will be the preferred method. Using equal match (=) matches only complete, not partial, fields.
Type
String.
Search
The field is available for search via
Notes
search_string is a search-only field.
| Field | Type | Search |
|---|---|---|
| address | String | = |
| duid | String | = |
| fqdn | String | : ~ |
| mac_address | String | = |
| objtype | String | = |
| search_string | String | : = ~ |
