Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Metadata list
hiddentrue
||Product on coverpage|SBC Core|
||Product Release|10.x|
||Document Title|REST API Reference Guide - node|
||Document Number|<doc number>|
||Document Revision|<doc revision>|
||Filename|<doc #>_<doc revision>_<product name>_<release #>_<title>|


Resources | node

Image Modifiednode

List of managed VMs.

Exists on Condition/system/configMode='oam' or /system/configMode='managed-vm'

Configuration


ParameterPresenceTypeDefaultDescription
Image ModifiedImage Modified
nodeNameMstring
The name of the managed node.
Image Modified
profilesO

Profiles of configuration shared by multiple objects.
Image Modified
alarmsO

Alarm Management
Image Modified
systemO

System-level configuration.
Image Modified
globalO

Global objects that are applicable Node wide
Image Modified
oamO

Operations and Maintenance objects.

Operational Data


ParameterDescription
Image Modified
addressContextObjects scoped to a specific IP addressing domain.


REST API: GET Example

curl -kisu 'admin:secret' -X GET https://{SBX-SERVER}/api/config/node/{nodeName}


REST API: POST Example

curl -kisu 'admin:secret' -X POST -H 'Content-Type: application/vnd.yang.data+xml' https://{SBX-SERVER}/api/config --data '
<node>
     <nodeName>{nodeName}</nodeName>
</node>
'


REST API: DELETE Example

curl -kisu 'admin:secret' -X DELETE https://{SBX-SERVER}/api/config/node/{nodeName}