Skip to content

Latest commit

 

History

History
768 lines (506 loc) · 27.7 KB

NodeOperationsApi.md

File metadata and controls

768 lines (506 loc) · 27.7 KB
Raw

{{classname}}

All URIs are relative to https://localhost:8080/cmu/v1

Method HTTP request Description
AddAll Post /nodes Creates one or multiple new nodes
Delete Delete /nodes/{identifier} Deletes an existing node
DeleteAll Delete /nodes Deletes a set of existing nodes
DeleteAttributes Delete /nodes/{identifier}/attributes Removes all attributes of an existing node
DeleteGlobalAttribute Delete /nodes/attributes/{label} Deletes a global attribute defined for nodes
Get Get /nodes/{identifier} Gets one or more node(s)
GetAll Get /nodes Lists all nodes
GetAttributes Get /nodes/{identifier}/attributes Gets all attributes of a single node
GetAvailableAction Get /nodes/{identifier}/actions Gets list of available actions on an existing node
GetController Get /nodes/{nodeId}/controller Get a node controller if existing
GetGlobalAttribute Get /nodes/attributes/{label} Gets a global attribute defined for nodes
GetGlobalAttributes Get /nodes/attributes Gets all global attributes defined for nodes
GetImageUnassigned Get /nodes/no_image Lists all nodes that are not in any image group
GetNetworkUnassigned Get /nodes/no_network Lists all nodes that are not in any network group
GetNic Get /nodes/{nodeId}/nics/{nicId} Gets one nic of a single node
GetNics Get /nodes/{identifier}/nics Gets all nics of a single node
Put Put /nodes/{identifier} Updates an existing node
PutAll Put /nodes Updates a set of existing nodes
PutAttributes Put /nodes/{identifier}/attributes Adds or modifies attributes of an existing node
PutGlobalAttributes Put /nodes/attributes Adds or modifies global attributes for nodes
RunAction Post /nodes/{identifier}/actions/{action} Runs an action on a set of existing nodes
UnassignImage Post /nodes/no_image Remove a set of nodes from their current image group
UnassignNetwork Post /nodes/no_network Remove a set of nodes from their current network group

AddAll

AddAll(ctx, body) Creates one or multiple new nodes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body []Node Node(s) definition

Return type

(empty response body)

Authorization

X-Auth-Token

HTTP request headers

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

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

Delete

Delete(ctx, identifier) Deletes an existing node

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
identifier string Node identifier

Return type

(empty response body)

Authorization

X-Auth-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteAll

DeleteAll(ctx, optional) Deletes a set of existing nodes

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiDeleteAllOpts struct

Name Type Description Notes
body optional.Interface of MultipleIdentifierDto Nodes identifier
where optional. Filter resources matching provided where clause
force optional. Force operation when more than one resource is matched

Return type

(empty response body)

Authorization

X-Auth-Token

HTTP request headers

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

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

DeleteAttributes

DeleteAttributes(ctx, identifier) Removes all attributes of an existing node

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
identifier string Node identifier

Return type

(empty response body)

Authorization

X-Auth-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

DeleteGlobalAttribute

DeleteGlobalAttribute(ctx, label) Deletes a global attribute defined for nodes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
label string

Return type

(empty response body)

Authorization

X-Auth-Token

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

Get

Node Get(ctx, identifier, optional) Gets one or more node(s)

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetOpts struct

Name Type Description Notes

fields | optional.Interface of []string| Fields to display | where | optional.String| Filter resources matching provided where clause | allowsEmpty | optional.Bool| Do not fail when no resource is matched |

Return type

Node

Authorization

X-Auth-Token

HTTP request headers

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

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

GetAll

[]Node GetAll(ctx, optional) Lists all nodes

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetAllOpts struct

Name Type Description Notes
fields optional.Interface of []string Fields to display
where optional.String Filter resources matching provided where clause
allowsEmpty optional.Bool Do not fail when no resource is matched

Return type

[]Node

Authorization

X-Auth-Token

HTTP request headers

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

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

GetAttributes

map[string]interface{} GetAttributes(ctx, identifier, optional) Gets all attributes of a single node

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetAttributesOpts struct

Name Type Description Notes

fields | optional.Interface of []string| Fields to display |

Return type

map[string]interface{}

Authorization

X-Auth-Token

HTTP request headers

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

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

GetAvailableAction

[]Action GetAvailableAction(ctx, identifier, optional) Gets list of available actions on an existing node

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetAvailableActionOpts struct

Name Type Description Notes

fields | optional.Interface of []string| Fields to display | where | optional.String| Filter resources matching provided where clause | allowsEmpty | optional.Bool| Do not fail when no resource is matched |

Return type

[]Action

Authorization

X-Auth-Token

HTTP request headers

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

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

GetController

Controller GetController(ctx, nodeId, optional) Get a node controller if existing

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetControllerOpts struct

Name Type Description Notes

fields | optional.Interface of []string| Fields to display |

Return type

Controller

Authorization

X-Auth-Token

HTTP request headers

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

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

GetGlobalAttribute

string GetGlobalAttribute(ctx, label, optional) Gets a global attribute defined for nodes

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetGlobalAttributeOpts struct

Name Type Description Notes

fields | optional.Interface of []string| Fields to display |

Return type

string

Authorization

X-Auth-Token

HTTP request headers

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

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

GetGlobalAttributes

map[string]interface{} GetGlobalAttributes(ctx, optional) Gets all global attributes defined for nodes

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetGlobalAttributesOpts struct

Name Type Description Notes
fields optional.Interface of []string Fields to display

Return type

map[string]interface{}

Authorization

X-Auth-Token

HTTP request headers

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

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

GetImageUnassigned

[]Node GetImageUnassigned(ctx, optional) Lists all nodes that are not in any image group

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetImageUnassignedOpts struct

Name Type Description Notes
fields optional.Interface of []string Fields to display
where optional.String Filter resources matching provided where clause
allowsEmpty optional.Bool Do not fail when no resource is matched

Return type

[]Node

Authorization

X-Auth-Token

HTTP request headers

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

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

GetNetworkUnassigned

[]Node GetNetworkUnassigned(ctx, optional) Lists all nodes that are not in any network group

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetNetworkUnassignedOpts struct

Name Type Description Notes
fields optional.Interface of []string Fields to display
where optional.String Filter resources matching provided where clause
allowsEmpty optional.Bool Do not fail when no resource is matched

Return type

[]Node

Authorization

X-Auth-Token

HTTP request headers

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

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

GetNic

Nic GetNic(ctx, nodeId, nicId, optional) Gets one nic of a single node

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetNicOpts struct

Name Type Description Notes

fields | optional.Interface of []string| Fields to display |

Return type

Nic

Authorization

X-Auth-Token

HTTP request headers

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

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

GetNics

[]Nic GetNics(ctx, identifier, optional) Gets all nics of a single node

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiGetNicsOpts struct

Name Type Description Notes

fields | optional.Interface of []string| Fields to display | where | optional.String| Filter resources matching provided where clause | allowsEmpty | optional.Bool| Do not fail when no resource is matched |

Return type

[]Nic

Authorization

X-Auth-Token

HTTP request headers

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

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

Put

Node Put(ctx, body, identifier, optional) Updates an existing node

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Node Updated node definition
identifier string Node identifier
optional *NodeOperationsApiPutOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiPutOpts struct

Name Type Description Notes

where | optional.| Filter resources matching provided where clause | force | optional.| Force operation when more than one resource is matched |

Return type

Node

Authorization

X-Auth-Token

HTTP request headers

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

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

PutAll

[]Node PutAll(ctx, body, optional) Updates a set of existing nodes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body []Node Updated nodes definition
optional *NodeOperationsApiPutAllOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiPutAllOpts struct

Name Type Description Notes

nameAsId | optional.| Use name instead of UUID as identifier | [default to false] where | optional.| Filter resources matching provided where clause | force | optional.| Force operation when more than one resource is matched |

Return type

[]Node

Authorization

X-Auth-Token

HTTP request headers

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

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

PutAttributes

map[string]interface{} PutAttributes(ctx, body, identifier) Adds or modifies attributes of an existing node

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body AttributesDto Attributes to be added/modified
identifier string Node identifier

Return type

map[string]interface{}

Authorization

X-Auth-Token

HTTP request headers

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

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

PutGlobalAttributes

PutGlobalAttributes(ctx, optional) Adds or modifies global attributes for nodes

Required Parameters

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

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiPutGlobalAttributesOpts struct

Name Type Description Notes
body optional.Interface of AttributesDto

Return type

(empty response body)

Authorization

X-Auth-Token

HTTP request headers

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

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

RunAction

Task RunAction(ctx, identifier, action, optional) Runs an action on a set of existing nodes

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
identifier string Node identifier
action string Action
optional *NodeOperationsApiRunActionOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a NodeOperationsApiRunActionOpts struct

Name Type Description Notes

body | optional.Interface of map[string]interface{}| |

Return type

Task

Authorization

X-Auth-Token

HTTP request headers

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

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

UnassignImage

[]Node UnassignImage(ctx, body) Remove a set of nodes from their current image group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body MultipleIdentifierDto Nodes identifier

Return type

[]Node

Authorization

X-Auth-Token

HTTP request headers

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

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

UnassignNetwork

[]Node UnassignNetwork(ctx, body) Remove a set of nodes from their current network group

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body MultipleIdentifierDto Nodes identifier

Return type

[]Node

Authorization

X-Auth-Token

HTTP request headers

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

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