Update appliance network role and site assignment

post

http://127.0.0.1:8080/appliance/networkRoleAndSite

Modifies the network role (Hub/Spoke/NRHub) and site assignment for a specific appliance. Changing these values triggers cluster updates and overlay configuration updates when applicable.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

nePk

string

required

^\d+\.NE$

Network Element Primary Key - unique appliance identifier assigned by Orchestrator. Format: '.NE' (e.g., '0.NE', '10.NE').

Body Params

Appliance network role and site configuration to update. Only networkRole, site, and sitePriority fields are processed.

Request body for updating an appliance's network role and site assignment. All fields are optional; unspecified fields retain their current values.

networkRole

string

enum

Network topology role. '0' = Spoke (edge device), '1' = Hub (central device), '3' = NRHub (Non-Routing Hub). Note: NRHub requires appliance software version support.

Allowed:

site

string

Site name for clustering and topology grouping. Changing site triggers cluster updates for both old and new sites. If site doesn't exist, it will be created automatically.

sitePriority

integer

≥ 0

Priority within the site for clustering purposes. Higher values indicate higher priority. Used for failover ordering within a site.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

200Network role and site updated successfully.

400Bad Request - Invalid parameters or business rule violation.

500Internal Server Error - Appliance not found or server error.