Skip to content

Latest commit

 

History

History
88 lines (61 loc) · 4.1 KB

SearchApi.md

File metadata and controls

88 lines (61 loc) · 4.1 KB

{{classname}}

All URIs are relative to https://api-gw-service-nmn.local/apis/sls/v1

Method HTTP request Description
SearchHardwareGet Get /search/hardware Search for nodes matching a set of criteria
SearchNetworksGet Get /search/networks Perform a search for networks matching a set of criteria.

SearchHardwareGet

[]Hardware SearchHardwareGet(ctx, optional) Search for nodes matching a set of criteria

Search for nodes matching a set of criteria. Any of the properties of any entry in the database may be used as search keys.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *SearchApiSearchHardwareGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SearchApiSearchHardwareGetOpts struct

Name Type Description Notes
xname optional.Interface of string Matches the specified xname
parent optional.Interface of string Matches all objects that are direct children of the given xname
class optional.Interface of HardwareClass Matches all objects of the given class
type_ optional.Interface of HardwareType Matches all objects of the given type
powerConnector optional.Interface of string Matches all objects with the given xname in their power_connector property
object optional.Interface of string Matches all objects with the given xname in their object property.
nodeNics optional.Interface of string Matches all objects with the given xname in their node_nics property
networks optional.String Matches all objects with the given xname in their networks property
peers optional.Interface of string Matches all objects with the given xname in their peers property

Return type

[]Hardware

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SearchNetworksGet

[]Network SearchNetworksGet(ctx, optional) Perform a search for networks matching a set of criteria.

Perform a search for networks matching a set of criteria. Any of the properties of any entry in the database may be used as search keys.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *SearchApiSearchNetworksGetOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a SearchApiSearchNetworksGetOpts struct

Name Type Description Notes
name optional.String Matches the specified network name
fullName optional.String Matches the specified network full name
type_ optional.Interface of string Matches the specified network type
ipAddress optional.Interface of string Matches all networks that could contain the specified IP address in their IP ranges

Return type

[]Network

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]