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>550-xxxx|
||Document Revision|<doc revision>01.01|
||Filename|<doc #>_<doc revision>_<product name>_<release #>_<title>node_01|


Resources | node

node

List of managed VMs.

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

Configuration


ParameterPresenceTypeDefaultDescription
nodeNameMstring
The name of the managed node.
profilesO

Profiles of configuration shared by multiple objects.
alarmsO

Alarm Management
systemO

System-level configuration.
globalO

Global objects that are applicable Node wide
oamO

Operations and Maintenance objects.

Operational Data


ParameterDescription
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}