IMaster NCE-Fabric V100R021C10 RESTful API Development Guide

iMaster NCE-Fabric
V100R021C10
API Development Guide
Issue 01
Date 2022-04-29
HUAWEI TECHNOLOGIES CO., LTD.

Copyright © Huawei Technologies Co., Ltd. 2022. All rights reserved.
No part of this document may be reproduced or transmitted in any form or by any means without prior
written consent of Huawei Technologies Co., Ltd.
Trademarks and Permissions
and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective
holders.
Notice
The purchased products, services and features are stipulated by the contract made between Huawei and
the customer. All or part of the products, services and features described in this document may not be
within the purchase scope or the usage scope. Unless otherwise specified in the contract, all statements,
information, and recommendations in this document are provided "AS IS" without warranties, guarantees
or representations of any kind, either express or implied.
The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute a warranty of any kind, express or implied.
Huawei Technologies Co., Ltd.

Address: Huawei Industrial Base
Bantian, Longgang
Shenzhen 518129
People's Republic of China
Website: https://www.huawei.com
Email: support@huawei.com
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. i

iMaster NCE-Fabric
API Development Guide Contents
Contents
1 RESTFul API Reference........................................................................................................... 1

1.1 Interface Overview.................................................................................................................................................................. 1
1.2 Common Interface Mechanisms........................................................................................................................................ 1
1.2.1 Token Obtaining................................................................................................................................................................... 2
1.2.2 URL Format............................................................................................................................................................................ 4
1.2.3 Returned Response Value................................................................................................................................................. 5
1.2.4 service_name......................................................................................................................................................................... 5
1.3 Common Interface Information......................................................................................................................................... 6
1.4 Prerequisites.............................................................................................................................................................................. 9
1.5 Service Model......................................................................................................................................................................... 10
1.6 Interface Invocation Process............................................................................................................................................. 14
1.6.1 Overall Configuration Process....................................................................................................................................... 14
1.6.2 Communication Between an Intranet and the Internet.......................................................................................17
1.6.3 Load balancing of Traffic from the Internet Using an LB................................................................................... 18
1.6.4 Communication Between an Intranet and an External Private Network Through IPSec VPN...............20
1.6.5 Communication Between VPCs.................................................................................................................................... 22
1.6.6 Communication Within a VPC...................................................................................................................................... 24
1.6.7 Traffic Limiting of VMs Using Security Groups....................................................................................................... 26
1.6.8 Configuring HIROERService Interface Blacklists..................................................................................................... 27
1.6.9 Configuring the HIROAPIGService Interface Blacklist...........................................................................................31
1.7 Authentication Interface.....................................................................................................................................................33
1.8 SNMP........................................................................................................................................................................................ 35
1.8.1 Overview............................................................................................................................................................................... 35
1.8.2 MIB1....................................................................................................................................................................................... 36
1.8.2.1 MIB1................................................................................................................................................................................... 36
1.8.2.2 MIB Description.............................................................................................................................................................. 38
1.8.2.3 Alarm Fields Reported by MIB1................................................................................................................................ 39
1.8.2.4 MIB1 Trap..........................................................................................................................................................................46
1.8.2.4.1 Alarm Notification Trap............................................................................................................................................ 47
1.8.2.4.2 Alarm Synchronization Start Trap......................................................................................................................... 52
1.8.2.4.3 Alarm Synchronization Result Trap...................................................................................................................... 53
1.8.2.4.4 Alarm Synchronization End Trap........................................................................................................................... 58
1.8.2.4.5 KeepAlive Info (Heartbeat) Trap........................................................................................................................... 60
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. ii

iMaster NCE-Fabric
1.8.2.5 MIB1 Trap Sample..........................................................................................................................................................61

1.8.2.5.1 Active Alarm Notification Trap...............................................................................................................................62
1.8.2.5.2 Active Alarm Synchronization Start Trap............................................................................................................63
1.8.2.5.3 Active Alarm Synchronization Reporting Trap.................................................................................................. 63
1.8.2.5.4 Active Alarm Synchronization End Trap..............................................................................................................64
1.8.2.5.5 Heartbeat Trap............................................................................................................................................................ 65
1.8.3 Collecting Interconnection Parameters...................................................................................................................... 66
1.8.4 Important Notes................................................................................................................................................................ 70
1.8.5 Configuring the SNMP NBI............................................................................................................................................ 72
1.8.5.1 Configuration Operations............................................................................................................................................72
1.8.5.2 Configuring a Security Policy..................................................................................................................................... 85
1.8.5.3 Configuration Parameters........................................................................................................................................... 86
1.8.5.3.1 General Parameters................................................................................................................................................... 86
1.8.5.3.2 Advanced Configuration........................................................................................................................................... 87
1.8.5.3.3 Third-Party NMS....................................................................................................................................................... 100
1.8.6 Testing the SNMP NBI................................................................................................................................................... 106
1.8.6.1 MIB1................................................................................................................................................................................. 107
1.8.7 Configuring the SNMP NBI on the OSS.................................................................................................................. 108
1.8.7.1 Configuring the SNMPv3 NBI.................................................................................................................................. 108
1.8.8 Calling the SNMP NBI................................................................................................................................................... 111
1.8.8.1 MIB1 Subinterfaces..................................................................................................................................................... 112
1.8.8.1.1 Reporting Real-Time Alarms................................................................................................................................ 112
1.8.8.1.2 Changing Filter Criteria.......................................................................................................................................... 112
1.8.8.1.3 Synchronizing Alarms............................................................................................................................................. 114
1.8.8.1.4 Acknowledging Alarms...........................................................................................................................................119
1.8.8.1.5 Unacknowledging Alarms..................................................................................................................................... 121
1.8.8.1.6 Clearing Alarms........................................................................................................................................................ 123
1.8.8.1.7 Reporting Alarm Acknowledgement Status....................................................................................................126
1.8.8.1.8 Reporting Alarm Clearance Status..................................................................................................................... 126
1.9 Interface Reference............................................................................................................................................................ 127
1.9.1 User Authentication Service........................................................................................................................................ 127
1.9.1.1 Obtain a Token............................................................................................................................................................. 127
1.9.1.2 Delete a Token.............................................................................................................................................................. 130
1.9.1.3 Change Personal Password...................................................................................................................................... 132
1.9.1.4 Authenticate a User.................................................................................................................................................... 135
1.9.1.5 Log Out a Session........................................................................................................................................................ 137
1.9.1.6 Authenticate a User V1 (Compatible with Earlier Versions)........................................................................ 140
1.9.1.7 Add an SSO Server Whitelist................................................................................................................................... 143
1.9.1.8 Query SSO Server Whitelists....................................................................................................................................145
1.9.1.9 Delete SSO Server Whitelists in Batches............................................................................................................. 147
1.9.1.10 Modify an SSO Server Whitelist........................................................................................................................... 149
1.9.1.11 Authenticate a User V2 (Compatible with Earlier Versions)...................................................................... 151
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. iii

iMaster NCE-Fabric
1.9.1.12 Log Out a Session V2 (Compatible with Earlier Versions)......................................................................... 154

1.9.1.13 Authenticate a Common User or a Remote User.......................................................................................... 157
1.9.2 ZTP....................................................................................................................................................................................... 163
1.9.2.1 ZTP Region Management......................................................................................................................................... 164
1.9.2.1.1 Query Global Configurations............................................................................................................................... 164
1.9.2.1.2 Update Global Configurations............................................................................................................................. 166
1.9.2.1.3 Query Detailed Region Information by Region ID........................................................................................169
1.9.2.1.4 Query Basic Region Information......................................................................................................................... 175
1.9.2.1.5 Change the Password of a File Server.............................................................................................................. 178
1.9.2.1.6 Create a Region........................................................................................................................................................ 180
1.9.2.1.7 Modify a Region....................................................................................................................................................... 186
1.9.2.1.8 Delete a Region by ID............................................................................................................................................. 188
1.9.2.2 L3 Multicast Serviceon Logical Router................................................................................................................. 190
1.9.2.2.1 A resource pool needs to be created................................................................................................................. 190
1.9.2.2.2 Query Resource Pools............................................................................................................................................. 195
1.9.2.2.3 Delete Resource Pools............................................................................................................................................ 198
1.9.2.3 ZTP Whitelist Management..................................................................................................................................... 200
1.9.2.3.1 Create a Whitelist.....................................................................................................................................................201
1.9.2.3.2 Query Whitelists....................................................................................................................................................... 204
1.9.2.3.3 Delete Whitelists by region ID............................................................................................................................. 206
1.9.2.4 ZTP Open Topology Management.........................................................................................................................208
1.9.2.4.1 Import Devices.......................................................................................................................................................... 208
1.9.2.4.2 Query Device Information..................................................................................................................................... 216
1.9.2.4.3 Delete a Device......................................................................................................................................................... 224
1.9.2.4.4 Import Layer 2 Links............................................................................................................................................... 226
1.9.2.4.5 Query Layer 2 Link Information.......................................................................................................................... 229
1.9.2.4.6 Import Layer 3 Links............................................................................................................................................... 232
1.9.2.4.7 Query Layer 3 Links................................................................................................................................................. 235
1.9.2.4.8 Query Extended Device Information................................................................................................................. 238
1.9.2.4.9 Query Extended Layer 2 Link Information...................................................................................................... 240
1.9.2.4.10 Query Extended Layer 3 Link Information.................................................................................................... 242
1.9.2.4.11 Clear Topology Information by Region ID.....................................................................................................244
1.9.2.5 Task................................................................................................................................................................................... 245
1.9.2.5.1 Start ZTP Tasks.......................................................................................................................................................... 245
1.9.2.5.2 Stop ZTP Tasks by Region ID................................................................................................................................ 247
1.9.2.5.3 Update Device Ports................................................................................................................................................ 249
1.9.2.5.4 Query ZTP Tasks....................................................................................................................................................... 251
1.9.2.5.5 Query the Information About ZTP Tasks in All Regions............................................................................. 254
1.9.2.5.6 Query Syslog Information About ZTP Devices............................................................................................... 257
1.9.2.5.7 Isolate Devices........................................................................................................................................................... 260
1.9.2.5.8 Replace Devices........................................................................................................................................................ 262
1.9.2.5.9 Reset Devices............................................................................................................................................................. 264
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. iv

iMaster NCE-Fabric
1.9.2.6 ZTP Underlay Topology Management..................................................................................................................266

1.9.2.6.1 Export Topology Comparison Information...................................................................................................... 266
1.9.2.6.2 Query Topology Comparison Information....................................................................................................... 268
1.9.3 Physical Network.............................................................................................................................................................272
1.9.3.1 Physical Topology........................................................................................................................................................ 272
1.9.3.1.1 Query Device Groups.............................................................................................................................................. 273
1.9.3.1.2 Query Devices............................................................................................................................................................ 278
1.9.3.1.3 Query Host Links...................................................................................................................................................... 284
1.9.3.1.4 Query Hosts............................................................................................................................................................... 290
1.9.3.1.5 Query Device Links.................................................................................................................................................. 293
1.9.3.1.6 Query All Ports.......................................................................................................................................................... 299
1.9.3.1.7 Query Topologies in a Resource Pool................................................................................................................ 304
1.9.3.1.8 Query the DCN Network Topology.................................................................................................................... 308
1.9.3.1.9 Bypass Link Compatibility Configuration for Upgrade................................................................................ 311
1.9.3.1.10 Query the Bypass Link......................................................................................................................................... 312
1.9.3.2 Fabric............................................................................................................................................................................... 315
1.9.3.2.1 Create a Fabric.......................................................................................................................................................... 315
1.9.3.2.2 Query All Fabric Pools............................................................................................................................................ 322
1.9.3.2.3 Query a Fabric by ID............................................................................................................................................... 324
1.9.3.2.4 Update a Fabric by ID............................................................................................................................................. 325
1.9.3.2.5 Delete a Fabric by ID.............................................................................................................................................. 328
1.9.3.2.6 Query a Device Group with a Specified Role in a Specified Fabric.........................................................329
1.9.3.2.7 Query the Name and Usage of a Sub-resource............................................................................................ 332
1.9.3.2.8 Query the Total Number and Usage of Resources....................................................................................... 335
1.9.3.2.9 Query Node Relations............................................................................................................................................ 337
1.9.3.2.10 Update Node Relations........................................................................................................................................340
1.9.3.2.11 Add a Device Group to a Fabric........................................................................................................................ 342
1.9.3.2.12 Remove a Device Group from a Fabric.......................................................................................................... 346
1.9.3.2.13 Query Fabric Node Information........................................................................................................................347
1.9.3.3 Manage VAS Resource Pools................................................................................................................................... 352
1.9.3.3.1 Create a VAS Resource Pool................................................................................................................................. 352
1.9.3.3.2 Query the VAS Resource Pool List...................................................................................................................... 361
1.9.3.3.3 Query Details About a Specified VAS Resource Pool................................................................................... 363
1.9.3.3.4 Modify a Specified VAS Resource Pool............................................................................................................. 365
1.9.3.3.5 Delete a Specified VAS Resource Pool.............................................................................................................. 368
1.9.3.3.6 Add Device Groups to a VAS Resource Pool................................................................................................... 370
1.9.3.3.7 Delete a Device Group from a VAS Resource Pool....................................................................................... 372
1.9.3.3.8 Query Information About Device Groups in a Specified VAS Resource Pool...................................... 374
1.9.3.4 Relationship between Fabric and VAS..................................................................................................................377
1.9.3.4.1 Query Fabric-VAS Mappings by VAS Pool ID.................................................................................................. 377
1.9.3.4.2 Query Fabric VAS Mappings Based on the Fabric ID List...........................................................................379
1.9.3.5 Host Link.........................................................................................................................................................................381
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. v

iMaster NCE-Fabric
1.9.3.5.1 Import Host Access Links in a Batch................................................................................................................. 381

1.9.3.5.2 Delete Host Access Links in a Batch.................................................................................................................. 385
1.9.3.6 Device Link..................................................................................................................................................................... 388
1.9.3.6.1 Import Inter-Device Links in a Batch................................................................................................................. 388
1.9.3.6.2 Delete Inter-Device Links in a Batch................................................................................................................. 393
1.9.3.7 Open API for Device Discovery............................................................................................................................... 397
1.9.3.7.1 Modify an SNMP Account..................................................................................................................................... 398
1.9.3.7.2 Automatically Discover Devices.......................................................................................................................... 402
1.9.3.7.3 Device Polling Progress.......................................................................................................................................... 405
1.9.3.7.4 Add a Device.............................................................................................................................................................. 409
1.9.3.7.5 Result of the Add Operation................................................................................................................................ 411
1.9.3.7.6 Add Devices................................................................................................................................................................ 414
1.9.3.7.7 Delete Devices........................................................................................................................................................... 422
1.9.3.7.8 Save Authentication Information....................................................................................................................... 426
1.9.3.8 Device Groups............................................................................................................................................................... 429
1.9.3.8.1 Create a Device Group............................................................................................................................................430
1.9.3.8.2 Delete a Device Group........................................................................................................................................... 436
1.9.3.9 Query the Network Link List................................................................................................................................... 438
1.9.3.10 Host Link Status Query........................................................................................................................................... 447
1.9.3.10.1 Query Host Link Status........................................................................................................................................ 447
1.9.4 Public Service.................................................................................................................................................................... 450
1.9.4.1 Controller Resource Preconfiguration...................................................................................................................450
1.9.4.1.1 Preconfigure the Controller.................................................................................................................................. 450
1.9.4.2 External Gateway Management............................................................................................................................. 452
1.9.4.2.1 Query an External Gateway................................................................................................................................. 452
1.9.4.2.2 Update an External Gateway............................................................................................................................... 459
1.9.4.2.3 Delete an External Gateway and Related Interconnection Interfaces................................................... 467
1.9.4.2.4 Query an External Gateway................................................................................................................................. 469
1.9.4.2.5 Query External Gateways...................................................................................................................................... 473
1.9.4.2.6 Update the public IP usage status of an external gateway.......................................................................475
1.9.4.2.7 Query an External Gateway and Related Interconnection Interfaces....................................................478
1.9.4.2.8 Create an External Gateway and Related Interconnection Interfaces (Invoked in Easy Network
Deployment Mode)................................................................................................................................................................... 487
1.9.4.3 Routing Policy............................................................................................................................................................... 495
1.9.4.3.1 Create a Routing Policy.......................................................................................................................................... 496
1.9.4.3.2 Delete a Routing Policy by Router ID................................................................................................................499
1.9.4.3.3 Query a Routing Policy by Router ID................................................................................................................ 501
1.9.4.3.4 Update a Routing Policy by Router ID.............................................................................................................. 503
1.9.4.3.5 NFVI Routing Policy................................................................................................................................................. 505
1.9.4.4 BFD System Configuration Management............................................................................................................510
1.9.4.4.1 Create BFD System Configuration...................................................................................................................... 510
1.9.4.4.2 Query the BFD System Configuration List.......................................................................................................516
1.9.4.4.3 Query BFD System Configuration.......................................................................................................................522
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. vi

iMaster NCE-Fabric
1.9.4.4.4 Update BFD System Configuration.................................................................................................................... 524

1.9.4.4.5 Delete BFD System Configuration...................................................................................................................... 526
1.9.4.4.6 Add a Device to BFD System Configuration................................................................................................... 528
1.9.4.4.7 Remove a Device from BFD System Configuration...................................................................................... 530
1.9.4.5 Global Resources..........................................................................................................................................................532
1.9.4.5.1 Create a Resource Pool.......................................................................................................................................... 532
1.9.4.5.2 Delete a Resource Pool.......................................................................................................................................... 535
1.9.4.5.3 Create or destroy resource pools in batches...................................................................................................537
1.9.4.6 Easy VPC Management............................................................................................................................................. 539
1.9.4.6.1 Create an Easy VPC................................................................................................................................................. 539
1.9.4.7 DiffServ Domain Management............................................................................................................................... 553
1.9.4.7.1 Create a DiffServ Domain..................................................................................................................................... 553
1.9.4.7.2 Query the DiffServ Domain List.......................................................................................................................... 562
1.9.4.7.3 Query a DiffServ Domain...................................................................................................................................... 568
1.9.4.7.4 Update a DiffServ Domain.................................................................................................................................... 571
1.9.4.7.5 Delete a DiffServ Domain..................................................................................................................................... 574
1.9.4.8 Tenant Management.................................................................................................................................................. 576
1.9.4.8.1 Create a Tenant.........................................................................................................................................................576
1.9.4.8.2 Query All Tenants.....................................................................................................................................................582
1.9.4.8.3 Query a Tenant by ID..............................................................................................................................................587
1.9.4.8.4 Update a Tenant by ID........................................................................................................................................... 589
1.9.4.8.5 Delete a Tenant.........................................................................................................................................................592
1.9.4.8.6 Query the Number of Logical NEs and Fabric Resources Used by a Tenant.......................................593
1.9.5 Neutron.............................................................................................................................................................................. 596
1.9.5.1 Network.......................................................................................................................................................................... 596
1.9.5.1.1 Create a Network..................................................................................................................................................... 596
1.9.5.1.2 Query All Networks................................................................................................................................................. 614
1.9.5.1.3 Query a Network by ID.......................................................................................................................................... 616
1.9.5.1.4 Update a Network by ID........................................................................................................................................619
1.9.5.1.5 Delete a Network by ID......................................................................................................................................... 623
1.9.5.2 Subnet..............................................................................................................................................................................625
1.9.5.2.1 Create a Subnet........................................................................................................................................................ 625
1.9.5.2.2 Query Subnets........................................................................................................................................................... 634
1.9.5.2.3 Query a Subnet by ID............................................................................................................................................. 637
1.9.5.2.4 Update a Subnet by ID........................................................................................................................................... 640
1.9.5.2.5 Delete a Subnet by ID............................................................................................................................................ 643
1.9.5.3 Port................................................................................................................................................................................... 645
1.9.5.3.1 Create a Port.............................................................................................................................................................. 645
1.9.5.3.2 Query All Ports.......................................................................................................................................................... 670
1.9.5.3.3 Query a Port by ID................................................................................................................................................... 674
1.9.5.3.4 Update a Port by ID................................................................................................................................................ 677
1.9.5.3.5 Delete a Port by ID.................................................................................................................................................. 682
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. vii

iMaster NCE-Fabric
1.9.5.4 Router.............................................................................................................................................................................. 684

1.9.5.4.1 Create a Router......................................................................................................................................................... 684
1.9.5.4.2 Query All Routers..................................................................................................................................................... 694
1.9.5.4.3 Query a Router by ID.............................................................................................................................................. 696
1.9.5.4.4 Update a Router....................................................................................................................................................... 699
1.9.5.4.5 Delete a Router by ID............................................................................................................................................. 702
1.9.5.4.6 Create a Router Link............................................................................................................................................... 704
1.9.5.4.7 Add a Route by Router ID..................................................................................................................................... 708
1.9.5.4.8 Query a Router Link by Router ID...................................................................................................................... 712
1.9.5.4.9 Delete a Router Link by Router ID..................................................................................................................... 715
1.9.5.4.10 Delete a Route by Router ID.............................................................................................................................. 718
1.9.5.4.11 Query a Static Route by Router ID.................................................................................................................. 721
1.9.5.5 Internal Router APIs....................................................................................................................................................723
1.9.5.5.1 Create an Internal Router Interface by ID....................................................................................................... 723
1.9.5.5.2 Query Sunbet IDs..................................................................................................................................................... 727
1.9.5.5.3 Delete an Internal Router Interface by ID....................................................................................................... 729
1.9.5.6 Snat.................................................................................................................................................................................. 731
1.9.5.6.1 Create SNAT............................................................................................................................................................... 731
1.9.5.6.2 Query the SNAT List................................................................................................................................................ 736
1.9.5.6.3 Query SNAT by Name............................................................................................................................................ 740
1.9.5.6.4 Update the SNAT by Name.................................................................................................................................. 742
1.9.5.6.5 Delete SNAT by Name............................................................................................................................................744
1.9.5.7 Floating IP Address..................................................................................................................................................... 746
1.9.5.7.1 Create a Floating IP Address................................................................................................................................ 746
1.9.5.7.2 Query the Floating IP Address List..................................................................................................................... 751
1.9.5.7.3 Query a Floating IP Address by Name..............................................................................................................755
1.9.5.7.4 Update a Floating IP Address Based on the Name...................................................................................... 757
1.9.5.7.5 Delete a Floating IP Address by Name............................................................................................................. 759
1.9.5.8 Qos....................................................................................................................................................................................761
1.9.5.8.1 Create a QoS Policy................................................................................................................................................. 761
1.9.5.8.2 Query the QoS List.................................................................................................................................................. 769
1.9.5.8.3 Query QoS by Name............................................................................................................................................... 775
1.9.5.8.4 Update QoS by Name.............................................................................................................................................777
1.9.5.8.5 Delete a QoS Policy by Name.............................................................................................................................. 779
1.9.5.9 Security Group.............................................................................................................................................................. 781
1.9.5.9.1 Create a Security Group......................................................................................................................................... 781
1.9.5.9.2 Query Security Groups........................................................................................................................................... 785
1.9.5.9.3 Query a Security Group by Name...................................................................................................................... 788
1.9.5.9.4 Update a Security Group by Name.................................................................................................................... 790
1.9.5.9.5 Deleting a Security Group by Name..................................................................................................................792
1.9.5.10 Security Group Rules................................................................................................................................................ 793
1.9.5.10.1 Create a Security Rule.......................................................................................................................................... 793
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. viii

iMaster NCE-Fabric
1.9.5.10.2 Query Security Rules.............................................................................................................................................799

1.9.5.10.3 Query a Security Rule by Name....................................................................................................................... 803
1.9.5.10.4 Delete a Security Rule by Name.......................................................................................................................805
1.9.5.11 Firewall......................................................................................................................................................................... 807
1.9.5.11.1 Create a Firewall Rule.......................................................................................................................................... 807
1.9.5.11.2 Query All Firewalls................................................................................................................................................ 812
1.9.5.11.3 Query a Firewall Rule by ID............................................................................................................................... 814
1.9.5.11.4 Update a Firewall Rule by ID............................................................................................................................. 817
1.9.5.11.5 Delete a Firewall Rule by ID.............................................................................................................................. 820
1.9.5.12 Firewall Policies.......................................................................................................................................................... 822
1.9.5.12.1 Create a Firewall Policy....................................................................................................................................... 823
1.9.5.12.2 Query All Firewall Policies.................................................................................................................................. 827
1.9.5.12.3 Query a Firewall Policy by ID............................................................................................................................ 829
1.9.5.12.4 Update a Firewall Policy by ID.......................................................................................................................... 831
1.9.5.12.5 Delete a Firewall Policy by ID............................................................................................................................833
1.9.5.12.6 Bind a Firewall Rule to a Firewall Policy....................................................................................................... 835
1.9.5.12.7 Unbind a Firewall Rule from a Firewall Policy............................................................................................ 838
1.9.5.13 FirewallRule................................................................................................................................................................. 839
1.9.5.13.1 Create a Firewall Rule.......................................................................................................................................... 840
1.9.5.13.2 Query All Firewall Rules...................................................................................................................................... 848
1.9.5.13.3 Query a Firewall Rule by ID............................................................................................................................... 851
1.9.5.13.4 Update a Firewall Rule by ID............................................................................................................................. 853
1.9.5.13.5 Delete a Firewall Rule by ID.............................................................................................................................. 855
1.9.5.14 VPN Service................................................................................................................................................................. 857
1.9.5.14.1 Create a VPN Service............................................................................................................................................ 857
1.9.5.14.2 Query All VPN Services........................................................................................................................................ 863
1.9.5.14.3 Query a VPN Service by ID................................................................................................................................. 865
1.9.5.14.4 Update a VPN Service by ID...............................................................................................................................867
1.9.5.14.5 Delete a VPN Service by ID................................................................................................................................ 869
1.9.5.15 IkePolicy........................................................................................................................................................................ 871
1.9.5.15.1 Create an IKE Policy.............................................................................................................................................. 871
1.9.5.15.2 Query All IKE Policies........................................................................................................................................... 877
1.9.5.15.3 Query an IKE Policy by ID................................................................................................................................... 879
1.9.5.15.4 Update an IKE Policy by ID.................................................................................................................................881
1.9.5.15.5 Delete an IKE Policy by ID.................................................................................................................................. 884
1.9.5.16 IPsecPolicy.................................................................................................................................................................... 886
1.9.5.16.1 Create an IPsec Policy by ID............................................................................................................................... 886
1.9.5.16.2 Query All IPsec Policies........................................................................................................................................ 891
1.9.5.16.3 Query an IPsec Policy by ID............................................................................................................................... 894
1.9.5.16.4 Update an IPsec Policy by ID............................................................................................................................. 896
1.9.5.16.5 Delete an IPsec Policy by ID............................................................................................................................... 898
1.9.5.17 Ipsec Site Connection............................................................................................................................................... 900
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. ix

iMaster NCE-Fabric
1.9.5.17.1 Create an IPsec Site Connection....................................................................................................................... 900

1.9.5.17.2 Query All IPsec Site Connections......................................................................................................................908
1.9.5.17.3 Query an IPsec Site Connection by ID............................................................................................................ 910
1.9.5.17.4 Update an IPsec Site Connection by ID..........................................................................................................912
1.9.5.17.5 Delete an IPsec Site Connection by ID........................................................................................................... 915
1.9.5.18 L2BR............................................................................................................................................................................... 916
1.9.5.18.1 Create L2BRs in Batches...................................................................................................................................... 917
1.9.5.18.2 Update L2BRs in Batches.................................................................................................................................... 925
1.9.5.18.3 Delete L2BRs in Batches...................................................................................................................................... 928
1.9.5.18.4 Create an L2BR....................................................................................................................................................... 931
1.9.5.18.5 Query All L2BRs...................................................................................................................................................... 934
1.9.5.18.6 Query an L2BR by ID............................................................................................................................................ 936
1.9.5.18.7 Update an L2BR by ID.......................................................................................................................................... 938
1.9.5.18.8 Delete an L2BR by ID........................................................................................................................................... 940
1.9.5.19 VpcConnection........................................................................................................................................................... 942
1.9.5.19.1 Create a VPC Communication Instance......................................................................................................... 942
1.9.5.19.2 Query VPC Connections....................................................................................................................................... 952
1.9.5.19.3 Query a VPC Communication Instance.......................................................................................................... 961
1.9.5.19.4 Update a VPC Communication Instance........................................................................................................964
1.9.5.19.5 Delete a VPC Communication Instance......................................................................................................... 968
1.9.5.20 L2 DC/POD Interconnection.................................................................................................................................. 970
1.9.5.20.1 Create a Layer 2 DC/POD Interconnection Instance................................................................................. 970
1.9.5.20.2 L2 DC/POD Interconnection............................................................................................................................... 975
1.9.5.20.3 Query a Layer 2 DC/POD Interconnection Instance by ID...................................................................... 977
1.9.5.20.4 Update a Layer 2 DC/POD Interconnection Instance................................................................................ 979
1.9.5.20.5 Delete a Router DCI.............................................................................................................................................. 981
1.9.5.21 DCI L3............................................................................................................................................................................ 983
1.9.5.21.1 L3 DC/POD Interconnection............................................................................................................................... 983
1.9.5.21.2 L3Dci Subnet......................................................................................................................................................... 1000
1.9.5.21.3 Delete L3 Dci Subnet..........................................................................................................................................1003
1.9.5.22 Heartbeat Connectivity of the Cloud Platform.............................................................................................1007
1.9.5.22.1 Detect Heartbeats Between the Cloud Platform and the Controller................................................ 1007
1.9.5.23 Neutron Routing Whitelist...................................................................................................................................1010
1.9.5.23.1 Query Routing Whitelist Information...........................................................................................................1010
1.9.6 K8S..................................................................................................................................................................................... 1013
1.9.6.1 Container Platform................................................................................................................................................... 1013
1.9.6.1.1 Query All Container Platforms.......................................................................................................................... 1013
1.9.6.1.2 Query a Container Platform by ID................................................................................................................... 1020
1.9.6.1.3 Update a Container Platform by ID................................................................................................................ 1023
1.9.6.1.4 Check Connectivity Between the Container Platform and the Controller......................................... 1035
1.9.6.2 Container Tenant....................................................................................................................................................... 1038
1.9.6.2.1 Create a Tenant...................................................................................................................................................... 1038
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. x

iMaster NCE-Fabric
1.9.6.2.2 Query All Tenants.................................................................................................................................................. 1044

1.9.6.2.3 Query a Tenant by ID........................................................................................................................................... 1048
1.9.6.2.4 Delete a Tenant by ID.......................................................................................................................................... 1051
1.9.6.3 Container Network................................................................................................................................................... 1053
1.9.6.3.1 Create a Network.................................................................................................................................................. 1053
1.9.6.3.2 Query All Networks...............................................................................................................................................1063
1.9.6.3.3 Query a Network by ID....................................................................................................................................... 1068
1.9.6.3.4 Delete a Network by ID....................................................................................................................................... 1071
1.9.6.4 Container Port............................................................................................................................................................ 1073
1.9.6.4.1 Create a Port........................................................................................................................................................... 1073
1.9.6.4.2 Query All Ports....................................................................................................................................................... 1085
1.9.6.4.3 Query a Port by ID................................................................................................................................................ 1092
1.9.6.4.4 Update a Port by ID.............................................................................................................................................. 1095
1.9.6.4.5 Delete a Port by ID................................................................................................................................................ 1099
1.9.6.5 Container Node.......................................................................................................................................................... 1101
1.9.6.5.1 Create a Container Node.................................................................................................................................... 1101
1.9.6.5.2 Query All Container Nodes................................................................................................................................ 1106
1.9.6.5.3 Query a Container Node by ID......................................................................................................................... 1109
1.9.6.5.4 Update a Container Node by ID....................................................................................................................... 1111
1.9.6.5.5 Delete a Container Node by ID.........................................................................................................................1113
1.9.6.6 Container Services..................................................................................................................................................... 1114
1.9.6.6.1 Create a container service.................................................................................................................................. 1115
1.9.6.6.2 Query Container Services.................................................................................................................................... 1124
1.9.6.6.3 Query a Container Service by ID...................................................................................................................... 1128
1.9.6.6.4 Modify a Container Service................................................................................................................................ 1131
1.9.6.6.5 Delete a container service.................................................................................................................................. 1135
1.9.7 VPC.................................................................................................................................................................................... 1137
1.9.7.1 Logical Network Management............................................................................................................................. 1137
1.9.7.1.1 Create a Logical Network................................................................................................................................... 1138
1.9.7.1.2 Query All Logical Networks............................................................................................................................... 1142
1.9.7.1.3 Query All Logical Networks............................................................................................................................... 1148
1.9.7.1.4 Update a Logical Network by ID...................................................................................................................... 1150
1.9.7.1.5 Delete a Logical Network by ID........................................................................................................................1154
1.9.7.2 Logical Subnet Management................................................................................................................................ 1156
1.9.7.2.1 Create a Subnet...................................................................................................................................................... 1156
1.9.7.2.2 Query Subnets........................................................................................................................................................ 1162
1.9.7.2.3 Query a Subnet by ID........................................................................................................................................... 1170
1.9.7.2.4 Update a Subnet by ID........................................................................................................................................ 1173
1.9.7.2.5 Delete a Subnet by ID.......................................................................................................................................... 1178
1.9.7.3 Logical Switch Management................................................................................................................................. 1180
1.9.7.3.1 Create a Logical Switch....................................................................................................................................... 1180
1.9.7.3.2 Query Logical Switches........................................................................................................................................ 1191
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xi

iMaster NCE-Fabric
1.9.7.3.3 Query Information About All Logical Access Switches............................................................................. 1203

1.9.7.3.4 Query a Logical Switch by ID............................................................................................................................ 1210
1.9.7.3.5 Update a Logical Switch by ID.......................................................................................................................... 1213
1.9.7.3.6 Delete a Logical Switch by ID............................................................................................................................1220
1.9.7.4 Logical Port Management......................................................................................................................................1221
1.9.7.4.1 Logical Port Management.................................................................................................................................. 1221
1.9.7.4.2 Query All Logical Ports........................................................................................................................................ 1229
1.9.7.4.3 Query Logical Port Information Based on the End Port ID List.............................................................1238
1.9.7.4.4 Query a Logical Port by ID................................................................................................................................. 1240
1.9.7.4.5 Update a Logical Port by ID............................................................................................................................... 1243
1.9.7.4.6 Update a Logical Port by ID............................................................................................................................... 1246
1.9.7.5 Logical Port Group Management........................................................................................................................ 1247
1.9.7.5.1 Create a Logical Port Group...............................................................................................................................1247
1.9.7.5.2 Update a Logical Port Group............................................................................................................................. 1254
1.9.7.5.3 Delete a Logical Port Group...............................................................................................................................1259
1.9.7.6 Logical Router Management.................................................................................................................................1261
1.9.7.6.1 Create a Logical Router....................................................................................................................................... 1261
1.9.7.6.2 Query the Logical Router List............................................................................................................................ 1269
1.9.7.6.3 Query the Logical Router List............................................................................................................................ 1293
1.9.7.6.4 Query Information About All Logical Routers............................................................................................. 1299
1.9.7.6.5 Query Information About a Logical Router.................................................................................................. 1307
1.9.7.6.6 Update a Logical Router..................................................................................................................................... 1311
1.9.7.6.7 Delete a Logical Router....................................................................................................................................... 1314
1.9.7.6.8 Add Static Route Information to a Logical Router.....................................................................................1316
1.9.7.6.9 Update Static Routes on a Logical Router.................................................................................................... 1323
1.9.7.6.10 Query Static Route Information on a Logical Router............................................................................. 1326
1.9.7.6.11 Delete Static Route Information from a Logical Router........................................................................ 1328
1.9.7.6.12 Query Static Routes in Batches Based on Specified Conditions..........................................................1330
1.9.7.6.13 Add BGP Peers to a Logical Router............................................................................................................... 1333
1.9.7.6.14 Update BGP Peers on a Logical Router....................................................................................................... 1343
1.9.7.6.15 Query BGP Peer Information on a Logical Router...................................................................................1346
1.9.7.6.16 Delete BGP Peers from a Logical Router.................................................................................................... 1348
1.9.7.6.17 Query BGP Peer Information in Batches Based on Specified Conditions.........................................1350
1.9.7.6.18 Query Device Groups Bound to a Logical Router.................................................................................... 1353
1.9.7.6.19 Query Device Groups Bound to a Logical Router in Batches...............................................................1356
1.9.7.6.20 Query Routing Policies Bound to a Logical Router................................................................................. 1358
1.9.7.6.21 Bind Routing Policies to a Logical Router...................................................................................................1361
1.9.7.6.22 Unbind Routing Policies from a Logical Router........................................................................................1363
1.9.7.6.23 Bind Device Groups to a Logical Router......................................................................................................1365
1.9.7.6.24 Unbind Device Groups from a Logical Router...........................................................................................1368
1.9.7.6.25 Query the Binding Relationship Between a Logical Router and an External Gateway.............. 1370
1.9.7.6.26 Bind an External Gateway to a Logical Router......................................................................................... 1373
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xii

iMaster NCE-Fabric
1.9.7.6.27 Switch Active and Standby Fabrics of a Logical Router......................................................................... 1375

1.9.7.7 Logical Interface Management............................................................................................................................ 1377
1.9.7.7.1 Create a Layer 3 Logical Interface................................................................................................................... 1377
1.9.7.7.2 Query Logical Interfaces......................................................................................................................................1388
1.9.7.7.3 Query a Layer 3 Logical Interface by ID........................................................................................................ 1399
1.9.7.7.4 Update a Logical Layer 3 Port........................................................................................................................... 1402
1.9.7.7.5 Delete a Layer 3 Logical Interface................................................................................................................... 1405
1.9.7.8 Logical link Management.......................................................................................................................................1407
1.9.7.8.1 Create a Logical Link............................................................................................................................................ 1407
1.9.7.8.2 Query the Logical Link Information List........................................................................................................ 1414
1.9.7.8.3 Query Logical Link Information........................................................................................................................ 1419
1.9.7.8.4 Delete a Logical Link............................................................................................................................................ 1421
1.9.7.9 End Port Management............................................................................................................................................ 1422
1.9.7.9.1 Create an End Port................................................................................................................................................ 1422
1.9.7.9.2 Query All End Ports............................................................................................................................................... 1425
1.9.7.9.3 Query an End Port by ID..................................................................................................................................... 1432
1.9.7.9.4 Update an End Port by ID................................................................................................................................... 1434
1.9.7.9.5 Delete an End Port by ID.................................................................................................................................... 1437
1.9.7.10 Logical VAS............................................................................................................................................................... 1439
1.9.7.10.1 Create a Logical VAS NE................................................................................................................................... 1439
1.9.7.10.2 Query the Logical VAS List............................................................................................................................... 1446
1.9.7.10.3 Query a Logical VAS NE by ID........................................................................................................................ 1448
1.9.7.10.4 Update a Logical VAS NE by ID......................................................................................................................1450
1.9.7.10.5 Delete a Logical VAS NE by ID....................................................................................................................... 1452
1.9.7.10.6 Query Southbound Configurations Based on VAS ID............................................................................. 1454
1.9.7.10.7 Query a Logical Link by ID on a Logical VAS Device.............................................................................. 1457
1.9.7.10.8 Create an Internal Link by ID on a Logical VAS Device......................................................................... 1462
1.9.7.10.9 Delete an Intenal Link....................................................................................................................................... 1465
1.9.7.10.10 Add New Routes for a Logical VAS Device.............................................................................................. 1467
1.9.7.10.11 Query New Routes for a Logical VAS Device in Batches.....................................................................1471
1.9.7.10.12 Update New Routes for a Logical VAS Device........................................................................................1473
1.9.7.10.13 Delete New Routes from a Logical VAS Device..................................................................................... 1475
1.9.7.11 Logical Topology Management......................................................................................................................... 1477
1.9.7.11.1 Query End Ports on VMs/BMs........................................................................................................................ 1477
1.9.7.11.2 Query the Device Mapping Information of All Logical Interfaces..................................................... 1484
1.9.7.11.3 Query the Device Mapping Information of All Logical Ports...............................................................1489
1.9.7.11.4 Query the Device Mapping Information of All Logical Routers Based on a Specified Condition
....................................................................................................................................................................................................... 1493
1.9.7.11.5 Query the Device Mapping Information of All Logical Switches........................................................1497
1.9.7.11.6 Query VXLAN Tunnels....................................................................................................................................... 1501
1.9.7.11.7 Query All VXLAN Ingress Replication Tables............................................................................................. 1504
1.9.7.12 Logical Topology..................................................................................................................................................... 1507
1.9.7.12.1 Query Device Information Based on Conditions...................................................................................... 1507
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xiii

iMaster NCE-Fabric
1.9.7.13 Logical Topology (Not Recommended).......................................................................................................... 1517

1.9.7.13.1 Query the Information About the Logical Port Pair................................................................................1517
1.9.7.13.2 Query Logical Router Information................................................................................................................ 1521
1.9.7.13.3 Query Logical Switch Information................................................................................................................. 1524
1.9.7.13.4 Query Subnet Information............................................................................................................................... 1527
1.9.7.13.5 Query Logical Port Mapping Information...................................................................................................1530
1.9.7.13.6 Query Information About All Tenants..........................................................................................................1533
1.9.7.14 VPC Communication.............................................................................................................................................. 1535
1.9.7.14.1 Create VPC Communication............................................................................................................................ 1535
1.9.7.14.2 Query the VPC Interworking List................................................................................................................... 1541
1.9.7.14.3 Query a VPC Interworking Connection by Name.....................................................................................1546
1.9.7.14.4 Update a VPC Interworking Connection by Name.................................................................................. 1548
1.9.7.14.5 Delete a VPC Interworking Connection by Name.................................................................................... 1550
1.9.7.14.6 Create a VPC Communication Instance....................................................................................................... 1551
1.9.7.14.7 Query VPC Connections.................................................................................................................................... 1561
1.9.7.14.8 Query a VPC Communication Instance........................................................................................................1570
1.9.7.14.9 Update a VPC Communication Instance..................................................................................................... 1573
1.9.7.14.10 Delete a VPC Communication Instance.................................................................................................... 1577
1.9.7.15 Application Example of the VPC Communication Policy.......................................................................... 1579
1.9.7.15.1 Create a VPC Communication Policy Application Instance...................................................................1579
1.9.7.15.2 Query the VPC Communication Policy Application Instance List....................................................... 1607
1.9.7.15.3 Query a VPC Communication Policy Application Instance................................................................... 1610
1.9.7.15.4 Update a VPC Communication Policy Application Instance................................................................. 1613
1.9.7.15.5 Delete a VPC Communication Policy Application Instance.................................................................. 1617
1.9.7.16 External Network Management........................................................................................................................ 1619
1.9.7.16.1 Query All Logical Networks............................................................................................................................. 1619
1.9.7.16.2 Query an External Network by ID................................................................................................................. 1622
1.9.7.17 External Network Connection............................................................................................................................ 1624
1.9.7.17.1 Create an External Network Connection.....................................................................................................1624
1.9.7.17.2 Query External Network Connections..........................................................................................................1632
1.9.7.17.3 Query External Network Connections..........................................................................................................1639
1.9.7.17.4 Update an External Connection by ID (Only NAT64 Prefix Update Is Supported)...................... 1642
1.9.7.17.5 Delete an External Network Connection.................................................................................................... 1646
1.9.7.17.6 Add a Subnet to an External Network......................................................................................................... 1647
1.9.7.17.7 Remove a Subnet from an External Network........................................................................................... 1650
1.9.7.17.8 Query Subnets Connecting to an External Network............................................................................... 1652
1.9.7.18 DHCP Group Management..................................................................................................................................1655
1.9.7.18.1 Create a DHCP Group........................................................................................................................................ 1656
1.9.7.18.2 Query DHCP Groups........................................................................................................................................... 1661
1.9.7.18.3 Query a DHCP Group by ID............................................................................................................................. 1667
1.9.7.18.4 Update a DHCP Group...................................................................................................................................... 1669
1.9.7.18.5 Delete a DHCP Group........................................................................................................................................ 1671
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xiv

iMaster NCE-Fabric
1.9.7.19 Flow Rule................................................................................................................................................................... 1673

1.9.7.19.1 Create a Flow Rule.............................................................................................................................................. 1673
1.9.7.19.2 Delete a Flow Rule.............................................................................................................................................. 1675
1.9.7.20 DHCP Relay Management of Subnet...............................................................................................................1677
1.9.7.20.1 Associate a Subnet with a DHCP Group......................................................................................................1677
1.9.7.20.2 Disassociate a Subnet from a DHCP Group............................................................................................... 1679
1.9.7.21 Logical Router Configuration Management..................................................................................................1680
1.9.7.21.1 Create a Device Group Configuration Service on a Logical Router, Including the Best-Effort Path
and FRR.......................................................................................................................................................................................1681
1.9.7.21.2 Query Device Group Configuration Services of a Logical Router, Including the Best-Effort Path
and FRR.......................................................................................................................................................................................1687
1.9.7.21.3 Configuring Service Parameters for a Logical Router Group, Including Best-Effort Path and FRR
....................................................................................................................................................................................................... 1694
1.9.7.21.4 Query a Device Group Configuration Service by ID on a Logical Router, Including the Best-Effort
Path and FRR............................................................................................................................................................................ 1699
1.9.7.21.5 Update a Device Group Configuration Service by ID on a Logical Router, Including the Best-
Effort Path and FRR................................................................................................................................................................ 1701
1.9.7.21.6 Delete a Device Group Configuration Service by ID from a Logical Router, Including the Best-
Effort Path and FRR................................................................................................................................................................ 1704
1.9.7.22 Loopback Interface Management..................................................................................................................... 1706
1.9.7.22.1 Create a Loopback Interface........................................................................................................................... 1706
1.9.7.22.2 Query the Loopback Interface List................................................................................................................ 1710
1.9.7.22.3 Query a Loopback Interface............................................................................................................................ 1715
1.9.7.22.4 Update a Loopback Interface.......................................................................................................................... 1717
1.9.7.22.5 Delete a Loopback Interface........................................................................................................................... 1720
1.9.7.23 L2 and L3 Logical API Management................................................................................................................ 1721
1.9.7.23.1 L2 and L3 Logical API Management.............................................................................................................1721
1.9.7.24 OSPF Process Management................................................................................................................................ 1724
1.9.7.24.1 Create an OSPF Process.................................................................................................................................... 1724
1.9.7.24.2 Query the OSPF Process List........................................................................................................................... 1736
1.9.7.24.3 Query OSPF Process Information...................................................................................................................1749
1.9.7.24.4 Update OSPF Process Information................................................................................................................ 1752
1.9.7.24.5 Delete OSPF Process Information.................................................................................................................. 1758
1.9.7.24.6 Create an OSPF Neighbor................................................................................................................................ 1759
1.9.7.24.7 Query the OSPF Neighbor List........................................................................................................................1764
1.9.7.24.8 Query OSPF Neighbor Information...............................................................................................................1771
1.9.7.24.9 Update OSPF Neighbor Information............................................................................................................ 1773
1.9.7.24.10 Delete OSPF Neighbor Information........................................................................................................... 1775
1.9.7.24.11 Query OSPF Neighbor States........................................................................................................................1777
1.9.7.25 VPC Routing Whitelist........................................................................................................................................... 1779
1.9.7.25.1 Query Routing Whitelist Information by Router ID................................................................................ 1779
1.9.7.25.2 Update Routes in the Whitelist...................................................................................................................... 1782
1.9.7.25.3 Delete routing whitelist information by routing whitelist ID...............................................................1785
1.9.7.25.4 Create a Routing Whitelist............................................................................................................................... 1786
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xv

iMaster NCE-Fabric
1.9.7.25.5 Query Routing Whitelist Information by Condition................................................................................ 1788

1.9.7.25.6 Add Subnets to a Whitelist.............................................................................................................................. 1789
1.9.7.25.7 Delete subnets from a whitelist by subnet ID........................................................................................... 1792
1.9.7.25.8 Add routes to a whitelist by route ID........................................................................................................... 1794
1.9.7.25.9 Delete Specified Routing Whitelist Information....................................................................................... 1796
1.9.7.26 Routing Policy Management.............................................................................................................................. 1798
1.9.7.26.1 Create a Routing Policy..................................................................................................................................... 1798
1.9.7.26.2 Query the Routing Policy List..........................................................................................................................1811
1.9.7.26.3 Query Routing Policy Information.................................................................................................................1825
1.9.7.26.4 Update Routing Policy Information.............................................................................................................. 1828
1.9.7.26.5 Delete Routing Policy Information................................................................................................................ 1833
1.9.7.26.6 Add a Routing Policy Node.............................................................................................................................. 1835
1.9.7.26.7 Add a Routing Policy Node.............................................................................................................................. 1838
1.9.7.26.8 Delete a Routing Policy Node......................................................................................................................... 1841
1.9.7.27 NQA............................................................................................................................................................................. 1843
1.9.7.27.1 Query All NQA Names...................................................................................................................................... 1843
1.9.7.28 Application Group Management....................................................................................................................... 1847
1.9.7.28.1 Create an Application Group Mapping Policy........................................................................................... 1847
1.9.7.28.2 Query the Application Group Mapping Policy List.................................................................................. 1855
1.9.7.28.3 Query Application Group Mapping Policies............................................................................................... 1862
1.9.7.28.4 Update an Application Group Mapping Policy..........................................................................................1865
1.9.7.28.5 Delete an Application Group Mapping Policy........................................................................................... 1868
1.9.7.28.6 Query the Flattened List of Application Group Mapping Policies...................................................... 1870
1.9.7.28.7 Create an Area for an Application Group to Take Effect....................................................................... 1876
1.9.7.28.8 Query the List of Regions Where an Application Group Takes Effect...............................................1894
1.9.7.28.9 Query the Area Where an Application Group Takes Effect.................................................................. 1905
1.9.7.28.10 Update the Area Where the Application Group Takes Effect............................................................ 1908
1.9.7.28.11 Delete the Area Where an Application Group Takes Effect............................................................... 1912
1.9.7.29 VPN Service............................................................................................................................................................... 1914
1.9.7.29.1 Create a VPN Service......................................................................................................................................... 1914
1.9.7.29.2 Query All VPN Services......................................................................................................................................1921
1.9.7.29.3 Query a VPN Service by ID.............................................................................................................................. 1923
1.9.7.29.4 Update a VPN Service by ID............................................................................................................................ 1925
1.9.7.29.5 Delete a VPN Service by ID.............................................................................................................................. 1927
1.9.7.29.6 Create a L2VPN or L3VPN Service................................................................................................................. 1929
1.9.7.29.7 Query L2VPN or L3VPN Services................................................................................................................... 1934
1.9.7.29.8 Query L2VPN or L3VPN Service Details...................................................................................................... 1941
1.9.7.29.9 Update L2VPN or L3VPN Services................................................................................................................. 1943
1.9.7.29.10 Delete a L2VPN or L3VPN Service.............................................................................................................. 1945
1.9.7.30 Layer 2 DCI................................................................................................................................................................1947
1.9.7.30.1 Create a Layer 2 DCI Instance.........................................................................................................................1947
1.9.7.30.2 Query the List of Layer 2 DCI Instances...................................................................................................... 1955
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xvi

iMaster NCE-Fabric
1.9.7.30.3 Query Layer 2 DCI Instances........................................................................................................................... 1957

1.9.7.30.4 Update a Layer 2 DCI Instance....................................................................................................................... 1959
1.9.7.30.5 Delete a Layer 2 DCI Instance.........................................................................................................................1962
1.9.7.31 Layer 3 DCI................................................................................................................................................................1964
1.9.7.31.1 Create a Layer 3 DCI Instance.........................................................................................................................1964
1.9.7.31.2 Query the List of Layer 3 DCI Instances...................................................................................................... 1971
1.9.7.31.3 Query Layer 3 DCI Instances........................................................................................................................... 1974
1.9.7.31.4 Update a Layer 3 DCI Instance....................................................................................................................... 1976
1.9.7.31.5 Delete a Layer 3 DCI Instance.........................................................................................................................1979
1.9.7.32 QoS Management.................................................................................................................................................. 1980
1.9.7.32.1 Create a QoS Entry............................................................................................................................................. 1981
1.9.7.32.2 Query All QoS Information.............................................................................................................................. 1985
1.9.7.32.3 Update QoS Information.................................................................................................................................. 1990
1.9.7.32.4 Delete QoS Information.................................................................................................................................... 1993
1.9.7.32.5 Create a Classifier................................................................................................................................................1995
1.9.7.32.6 Query All Classifier Information..................................................................................................................... 1997
1.9.7.32.7 Update Classifier Information......................................................................................................................... 2001
1.9.7.32.8 Delete Classifier Information...........................................................................................................................2003
1.9.7.33 BFD Session Management................................................................................................................................... 2005
1.9.7.33.1 Create a BFD Session......................................................................................................................................... 2005
1.9.7.33.2 Query the BFD Session List.............................................................................................................................. 2012
1.9.7.33.3 Query a BFD Session.......................................................................................................................................... 2020
1.9.7.33.4 Update a BFD Session........................................................................................................................................2022
1.9.7.33.5 Delete a BFD Session......................................................................................................................................... 2025
1.9.7.33.6 Query BFD Session Running Status.............................................................................................................. 2027
1.9.7.34 BFD System Configuration Management.......................................................................................................2029
1.9.7.34.1 Create BFD System Configuration................................................................................................................. 2029
1.9.7.34.2 Query the BFD System Configuration List.................................................................................................. 2035
1.9.7.34.3 Query BFD System Configuration..................................................................................................................2041
1.9.7.34.4 Update BFD System Configuration............................................................................................................... 2043
1.9.7.34.5 Delete BFD System Configuration................................................................................................................. 2045
1.9.7.34.6 Add a Device to BFD System Configuration.............................................................................................. 2047
1.9.7.34.7 Remove a Device from BFD System Configuration................................................................................. 2049
1.9.7.35 BGP Configuration and Management............................................................................................................. 2051
1.9.7.35.1 Create BGP Configuration................................................................................................................................ 2051
1.9.7.35.2 Query BGP Configurations............................................................................................................................... 2059
1.9.7.35.3 Query BGP Configurations by ID................................................................................................................... 2066
1.9.7.35.4 Update BGP Configurations............................................................................................................................. 2068
1.9.7.35.5 Delete BGP Configurations.............................................................................................................................. 2070
1.9.7.36 VMM Management................................................................................................................................................ 2072
1.9.7.36.1 VMM Port Group................................................................................................................................................. 2072
1.9.7.36.2 VMM QoS Profile.................................................................................................................................................2089
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xvii

iMaster NCE-Fabric
1.9.7.36.3 VMM........................................................................................................................................................................ 2102

1.9.7.37 Reference Relationship Between External Services and Services on iMaster NCE-Fabric............. 2107
1.9.7.37.1 Create a Reference Relationship Between External Services and Services on iMaster NCE-Fabric
....................................................................................................................................................................................................... 2107
1.9.7.37.2 Delete the Reference Relationship Between External Services and Services on iMaster NCE-
Fabric........................................................................................................................................................................................... 2110
1.9.7.37.3 Query the Reference Relationship Between External Services and Services on iMaster NCE-
Fabric........................................................................................................................................................................................... 2112
1.9.8 MDC.................................................................................................................................................................................. 2115
1.9.8.1 Manage Edge Ports.................................................................................................................................................. 2115
1.9.8.1.1 Query Edge Ports that Meet Specified Conditions..................................................................................... 2115
1.9.8.1.2 Query the Edge Port with a Specified ID.......................................................................................................2121
1.9.8.2 Interconnection Interface....................................................................................................................................... 2123
1.9.8.2.1 Create a Single Interconnection Interface..................................................................................................... 2124
1.9.8.2.2 Query All Interconnected Interfaces............................................................................................................... 2142
1.9.8.2.3 Query Interconnection Interfaces by ID......................................................................................................... 2147
1.9.8.2.4 Update Interconnection Interface by Name................................................................................................. 2150
1.9.8.2.5 Delete an Interconnection Interface Based on the ID...............................................................................2154
1.9.8.3 Maintenance............................................................................................................................................................... 2157
1.9.8.3.1 Query the Logical VAS Associated with a Router.......................................................................................2157
1.9.8.3.2 Query Vaspools Based on Specified Conditions.......................................................................................... 2163
1.9.8.4 TransitRouter...............................................................................................................................................................2168
1.9.8.4.1 Create a Single Transit Router...........................................................................................................................2169
1.9.8.4.2 Query All Transit Routers.................................................................................................................................... 2181
1.9.8.4.3 Query a Transit Router Based on the ID........................................................................................................ 2184
1.9.8.4.4 Update a Transit Router...................................................................................................................................... 2186
1.9.8.4.5 Delete a Transit Router Based on the ID....................................................................................................... 2189
1.9.8.5 Transit VPC...................................................................................................................................................................2192
1.9.8.5.1 Create a Transit VPC............................................................................................................................................. 2192
1.9.8.5.2 Query All Transit VPCs......................................................................................................................................... 2198
1.9.8.5.3 Query a Transit VPC by VPC ID......................................................................................................................... 2200
1.9.8.5.4 Update a Transit VPC............................................................................................................................................2203
1.9.8.5.5 Delete a Transit VPC Based on the VPC ID................................................................................................... 2206
1.9.8.6 VpcConnect.................................................................................................................................................................. 2208
1.9.8.6.1 Create a VPC Interworking Connection..........................................................................................................2208
1.9.8.6.2 Query the VPC Interworking List...................................................................................................................... 2230
1.9.8.6.3 Query a VPC Interworking Connection by ID.............................................................................................. 2233
1.9.8.6.4 Update a VPC Interworking Connection Based on the ID....................................................................... 2236
1.9.8.6.5 Delete the VPC Interworking ID....................................................................................................................... 2239
1.9.8.7 East-west Traffic Application................................................................................................................................ 2242
1.9.8.7.1 Create a Single East-West Traffic Application............................................................................................. 2242
1.9.8.7.2 Query All East-West Traffic Applications.......................................................................................................2262
1.9.8.7.3 Delete East-West Traffic Applications in Batches Based on the IDS....................................................2270
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xviii

iMaster NCE-Fabric
1.9.8.7.4 Query East-West Traffic Applications by ID................................................................................................. 2272

1.9.8.7.5 Update East-West Traffic Applications...........................................................................................................2275
1.9.8.7.6 Delete East-West Traffic Applications Based on IDs................................................................................. 2278
1.9.8.8 FgwIpLink..................................................................................................................................................................... 2280
1.9.8.8.1 Create an Interconnection Relationship Between a Fabric Gateway and NCE (IP Domain).......2281
1.9.8.8.2 Query the Interconnection Relationship Between a Fabric Gateway and NCE (IP Domain)...... 2291
1.9.8.8.3 Query the Interconnection Relationship Between a Fabric Gateway and NCE (IP Domain) by ID
....................................................................................................................................................................................................... 2293
1.9.8.8.4 Update the Interconnection Between a Fabric Gateway and NCE (IP Domain) by ID................. 2295
1.9.8.8.5 Delete the Interconnection Between a Fabric Gateway and NCE (IP Domain) by ID................... 2298
1.9.8.8.6 Delete Interconnections Between Fabric Gateways and NCE (IP Domain) in Batches................. 2300
1.9.8.9 TrafficAppPolicy......................................................................................................................................................... 2303
1.9.8.9.1 Create a Single Application Group Policy...................................................................................................... 2303
1.9.8.9.2 Query the Application Group Policy List........................................................................................................2313
1.9.8.9.3 Query an Application Group Policy by ID..................................................................................................... 2317
1.9.8.9.4 Update the Application Group Policy Based on the ID............................................................................ 2320
1.9.8.9.5 Delete an Application Group Policy Based on the ID................................................................................2323
1.9.8.9.6 Delete Application Group Policies in Batches.............................................................................................. 2326
1.9.8.9.7 Query the Application Group Policy in Flat Mode Based on the Interconnection Relationship ID.
....................................................................................................................................................................................................... 2330
1.9.9 Multicast VPC (IPv4)....................................................................................................................................................2336
1.9.9.1 Multicast ACL..............................................................................................................................................................2336
1.9.9.1.1 Create Multicast ACLs.......................................................................................................................................... 2336
1.9.9.1.2 Query All Multicast ACLs.................................................................................................................................... 2339
1.9.9.1.3 Query a Multicast ACL by ID............................................................................................................................. 2344
1.9.9.1.4 Update a Multicast ACL.......................................................................................................................................2345
1.9.9.1.5 Delete a Multicast ACL by ID.............................................................................................................................2348
1.9.9.1.6 Create Multicast ACL Rules................................................................................................................................ 2349
1.9.9.1.7 Delete a Multicast ACL by ID.............................................................................................................................2351
1.9.9.2 Query a Layer 3 Multicast Service on a Logical Interface by ID...............................................................2353
1.9.9.2.1 Create a Layer 3 Multicast Service on a Logical Interface...................................................................... 2353
1.9.9.2.2 Query Layer 3 Multicast Services on All Logical Interfaces.................................................................... 2360
1.9.9.2.3 Query a Layer 3 Multicast Service on a Logical Interface by ID........................................................... 2369
1.9.9.2.4 Update a Layer 3 Multicast Service on a Logical Interface by ID......................................................... 2371
1.9.9.2.5 Delete a Layer 3 Multicast Service on a Logical Interface by ID.......................................................... 2375
1.9.9.3 L3 Multicast Serviceon Logical Router...............................................................................................................2376
1.9.9.3.1 Create Layer 3 Multicast Services on a Logical Router............................................................................ 2376
1.9.9.3.2 Query Layer 3 Multicast Services on All Logical Routers........................................................................ 2381
1.9.9.3.3 Query a Layer 3 Multicast Service by ID on a Logical Router............................................................... 2387
1.9.9.3.4 Query a Layer 3 Multicast Service by ID on a Logical Router............................................................... 2389
1.9.9.3.5 Delete a Layer 3 Multicast Service by ID from a Logical Router.......................................................... 2392
1.9.9.4 Multicast Replication Address of BUM Packet................................................................................................ 2393
1.9.9.4.1 Create Multicast Replication Addresses of BUM Packets........................................................................ 2394
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xix

iMaster NCE-Fabric
1.9.9.4.2 Query All Multicast Replication Addresses of BUM Packets...................................................................2397

1.9.9.4.3 Query Multicast Replication Address Details of BUM Packets by ID...................................................2401
1.9.9.4.4 Update Multicast Replication Addresses of BUM Packets by ID........................................................... 2403
1.9.9.4.5 Delete Multicast Replication Addresses of BUM Packets by ID.............................................................2405
1.9.9.5 Multicast Service on Logical Port........................................................................................................................ 2407
1.9.9.5.1 Create Multicast Services on a Logical Port................................................................................................. 2407
1.9.9.5.2 Query Multicast Services on All Logical Ports............................................................................................. 2411
1.9.9.5.3 Query a Multicast Service by ID on a Logical Port.................................................................................... 2416
1.9.9.5.4 Update a Multicast Service by ID on a Logical Port.................................................................................. 2418
1.9.9.5.5 Delete a Multicast Service by ID from a Logical Port............................................................................... 2421
1.9.9.6 MSDP............................................................................................................................................................................. 2422
1.9.9.6.1 Create an MSDP Entry......................................................................................................................................... 2423
1.9.9.6.2 Query an MSDP List.............................................................................................................................................. 2430
1.9.9.6.3 Query MSDP Entries............................................................................................................................................. 2438
1.9.9.6.4 Update MSDP Entries........................................................................................................................................... 2440
1.9.9.6.5 Delete MSDP Entries.............................................................................................................................................2443
1.9.9.7 Service Function Chain............................................................................................................................................ 2444
1.9.9.7.1 End Point Group (EPG)........................................................................................................................................ 2444
1.9.9.7.2 SF Type...................................................................................................................................................................... 2463
1.9.9.7.3 SFC Template...........................................................................................................................................................2465
1.9.9.7.4 SFC Application Instance..................................................................................................................................... 2476
1.9.9.7.5 SFC Application Instance..................................................................................................................................... 2491
1.9.10 Service Function Chain............................................................................................................................................. 2507
1.9.10.1 End Point Group (EPG)......................................................................................................................................... 2507
1.9.10.1.1 Create an EPG....................................................................................................................................................... 2507
1.9.10.1.2 Query EPGs............................................................................................................................................................ 2515
1.9.10.1.3 Query the EPG VMM.......................................................................................................................................... 2518
1.9.10.1.4 Query an EPG by ID............................................................................................................................................ 2521
1.9.10.1.5 Update an EPG..................................................................................................................................................... 2523
1.9.10.1.6 Delete an EPG by ID........................................................................................................................................... 2526
1.9.10.2 SF Type....................................................................................................................................................................... 2527
1.9.10.2.1 Query All SF Types Supported by the Controller......................................................................................2527
1.9.10.3 SFC Template............................................................................................................................................................ 2529
1.9.10.3.1 Create an SFC (Template)................................................................................................................................ 2530
1.9.10.3.2 Query SFCs (Templates)....................................................................................................................................2533
1.9.10.3.3 Query an SFC (Template) by ID..................................................................................................................... 2537
1.9.10.3.4 Delete an SFC (Template) by ID.................................................................................................................... 2539
1.9.10.4 SFC Policy.................................................................................................................................................................. 2541
1.9.10.4.1 Create an SFC Policy...........................................................................................................................................2541
1.9.10.4.2 Query SFC Policies...............................................................................................................................................2554
1.9.10.4.3 Query SFC Policies...............................................................................................................................................2563
1.9.10.4.4 Update an SFC by ID.......................................................................................................................................... 2566
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xx

iMaster NCE-Fabric
1.9.10.4.5 Delete an SFC Policy by ID............................................................................................................................... 2569

1.9.10.5 SFC Application Instance...................................................................................................................................... 2571
1.9.10.5.1 Create an SFC Application Instance.............................................................................................................. 2571
1.9.10.5.2 Query SFC Application Instances................................................................................................................... 2599
1.9.10.5.3 Query an SFC Application Instance by ID................................................................................................... 2602
1.9.10.5.4 Update an SFC Application Instance by ID.................................................................................................2605
1.9.10.5.5 Delete an SFC Application Instance by ID.................................................................................................. 2608
1.9.11 OAM................................................................................................................................................................................ 2610
1.9.11.1 Connectivity Detection Task Management.................................................................................................... 2610
1.9.11.1.1 Create a Connectivity Detection Task...........................................................................................................2610
1.9.11.1.2 Query All Connectivity Detection Tasks.......................................................................................................2614
1.9.11.1.3 Delete a Connectivity Detection Task by ID............................................................................................... 2618
1.9.11.1.4 Query a Connectivity Detection Task........................................................................................................... 2619
1.9.11.2 One-Click Emergency Plan.................................................................................................................................. 2621
1.9.11.2.1 Create an Atomic Template............................................................................................................................. 2621
1.9.11.2.2 Query Atomic Templates.................................................................................................................................. 2631
1.9.11.2.3 Query an Atomic Template.............................................................................................................................. 2633
1.9.11.2.4 Update an Atomic Template........................................................................................................................... 2635
1.9.11.2.5 Delete an Atomic Template............................................................................................................................. 2638
1.9.11.2.6 Execute an Atomic Template........................................................................................................................... 2639
1.9.11.2.7 Create an Integrated Template.......................................................................................................................2644
1.9.11.2.8 Query Integrated Templates............................................................................................................................ 2649
1.9.11.2.9 Query an Integrated Template....................................................................................................................... 2651
1.9.11.2.10 Update an Integrated Template.................................................................................................................. 2653
1.9.11.2.11 Delete an Integrated Template.................................................................................................................... 2655
1.9.11.2.12 Execute an Integrated Template.................................................................................................................. 2656
1.9.11.2.13 Query Historical Operations..........................................................................................................................2660
1.9.11.2.14 Roll Back Historical Operations................................................................................................................... 2663
1.9.11.3 Physical Port Traffic Statistics.............................................................................................................................2664
1.9.11.3.1 Physical Port Traffic Statistics......................................................................................................................... 2665
1.9.11.3.2 Query Port Traffic Statistics............................................................................................................................. 2667
1.9.11.4 Path Detection......................................................................................................................................................... 2671
1.9.11.4.1 Create a Single-Path Detection Task............................................................................................................ 2671
1.9.11.4.2 Stop a Single-Path Detection Task................................................................................................................ 2676
1.9.11.4.3 Query the Result of a Single-Path Detection Task by ID.......................................................................2678
1.9.11.4.4 Create a Multi-Path Detection Task..............................................................................................................2684
1.9.11.4.5 Enable Path Detection....................................................................................................................................... 2689
1.9.11.5 Flow Blocking Management............................................................................................................................... 2691
1.9.11.5.1 Create a Flow Blocking Policy......................................................................................................................... 2691
1.9.11.5.2 Delete a Flow Blocking Policy by ID............................................................................................................. 2696
1.9.11.5.3 Query a Flow Blocking Policy by ID.............................................................................................................. 2698
1.9.11.6 Edge Intelligent Network Traffic Analysis...................................................................................................... 2701
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxi

iMaster NCE-Fabric
1.9.11.6.1 Configure TCP_UDP Flow Analysis Rules.................................................................................................... 2701

1.9.11.6.2 Configure TCP_UDP Flow Analysis Packets................................................................................................ 2706
1.9.11.7 Devm Device Management................................................................................................................................. 2710
1.9.11.7.1 Query the Administrative Status and Optical Information of a Port................................................ 2710
1.9.11.8 Device Configurations........................................................................................................................................... 2714
1.9.11.8.1 Query Device Configurations.......................................................................................................................... 2714
1.9.11.9 resource info Apis................................................................................................................................................... 2716
1.9.11.9.1 Obtain Resource Information.......................................................................................................................... 2716
1.9.11.10 Manage Logical Switchand Router Health Status.................................................................................... 2719
1.9.11.10.1 Query the Health Status of a Logical Switch.......................................................................................... 2719
1.9.11.10.2 Query the Health Status of a Logical Router..........................................................................................2722
1.9.11.11 Asset Synchronization Interface...................................................................................................................... 2724
1.9.11.11.1 Query the List Information............................................................................................................................ 2724
1.9.11.12 Alarm Management............................................................................................................................................ 2727
1.9.11.12.1 Reporting Alarms or Events...........................................................................................................................2727
1.9.11.12.2 Reporting Alarm Definitions......................................................................................................................... 2741
1.9.11.12.3 Deleting Alarm Definitions............................................................................................................................ 2745
1.9.11.12.4 Reporting Possible Causes and Troubleshooting Suggestions of an Alarm..................................2747
1.9.11.12.5 Deleting Possible Causes and Troubleshooting Suggestions of an Alarm.................................... 2750
1.9.11.12.6 Submitting an Alarm Operation Task........................................................................................................ 2752
1.9.11.12.7 Canceling an Alarm Operation Task...........................................................................................................2762
1.9.11.12.8 Querying the Progress of an Alarm Operation.......................................................................................2763
1.9.11.12.9 Querying Serial Numbers of Current Alarms.......................................................................................... 2766
1.9.11.12.10 Querying Current Alarms by Serial Numbers....................................................................................... 2774
1.9.11.12.11 Querying Current Alarms in Batches....................................................................................................... 2788
1.9.11.12.12 Querying Serial Numbers of Historical Alarms.................................................................................... 2795
1.9.11.12.13 Querying Historical Alarms by Serial Numbers................................................................................... 2802
1.9.11.12.14 Querying an Alarm Definition List........................................................................................................... 2816
1.9.11.13 Performance Management............................................................................................................................... 2823
1.9.11.13.1 Querying Monitoring Resources.................................................................................................................. 2823
1.9.11.13.2 Creating a Real-Time Performance Task (Only Compatible with V300R010 and Earlier
Versions)..................................................................................................................................................................................... 2828
1.9.11.13.3 Creating a Real-Time Performance Task................................................................................................... 2837
1.9.11.13.4 Deleting a Real-Time Performance Task................................................................................................... 2843
1.9.11.13.5 Querying Real-Time Performance Task Information............................................................................ 2846
1.9.11.13.6 Creating a Performance Monitoring Task (Only Compatible with V300R010 and Earlier
Versions)..................................................................................................................................................................................... 2853
1.9.11.13.7 Creating a Performance Monitoring Task................................................................................................ 2862
1.9.11.13.8 Deleting a Performance Monitoring Task................................................................................................ 2868
1.9.11.13.9 Querying Historical Data (by KPI ID; Only Compatible with V300R010 and Earlier Versions)
....................................................................................................................................................................................................... 2871
1.9.11.13.10 Querying Historical Data (by KPI Key; Only Compatible with V300R010 and Earlier Versions)
....................................................................................................................................................................................................... 2880
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxii

iMaster NCE-Fabric
1.9.11.13.11 Querying Historical Data............................................................................................................................. 2890

1.9.11.13.12 Querying Measurement Objects (Only Compatible with V300R010 and Earlier Versions). 2898
1.9.11.14 Network-wide Snapshot.....................................................................................................................................2901
1.9.11.14.1 Create a Network-wide Snapshot............................................................................................................... 2901
1.9.11.14.2 Query All Backup Snapshots......................................................................................................................... 2905
1.9.11.14.3 Query the Progress of a Specified Network-wide Snapshot Generation Task............................. 2907
1.9.11.14.4 Delete a Network-wide Snapshot............................................................................................................... 2912
1.9.11.14.5 Perform a Network-wide Rollback.............................................................................................................. 2914
1.9.11.14.6 Query All Rollback Tasks................................................................................................................................ 2916
1.9.11.14.7 Query the Progress of a Network-wide Rollback Task.........................................................................2918
1.9.11.14.8 Retry Network Device Configuration Rollback....................................................................................... 2920
1.9.11.14.9 Retry the Rollback of the Controller Database...................................................................................... 2923
1.9.11.14.10 Query All Historical Operation Records..................................................................................................2925
1.9.11.14.11 Query Historical Records..............................................................................................................................2927
1.9.11.15 VSwitch Diagnosis Interface............................................................................................................................. 2929
1.9.11.15.1 Query Commands Supported by the CE1800V Based on Conditions............................................. 2929
1.9.11.15.2 Run the Following Command on the CE1800V to Check the Command Output...................... 2933
1.9.11.16 gRPC Configuration on vSwitches.................................................................................................................. 2935
1.9.11.16.1 Create gRPC Service Configurations........................................................................................................... 2936
1.9.11.16.2 Update gRPC Service Configurations......................................................................................................... 2940
1.9.11.16.3 Query gRPC Service Configurations in Batches...................................................................................... 2942
1.9.11.16.4 Delete gRPC Service Configurations in Batches..................................................................................... 2946
1.9.11.17 ExternalSystemConnectionService.................................................................................................................. 2948
1.9.11.17.1 Provide Registration Subscription Information for Third-Party Systems....................................... 2948
1.9.11.17.2 Update Registration Subscription Information for Third-Party Systems....................................... 2951
1.9.11.17.3 Delete All Subscription Information About Third-Party Systems..................................................... 2952
1.9.11.17.4 Obtain Connectivity Detection Information............................................................................................ 2954
1.9.11.18 Underlay Configuration...................................................................................................................................... 2955
1.9.11.18.1 Eth-Trunk Configuration................................................................................................................................. 2955
1.9.11.18.2 Port Configuration............................................................................................................................................ 2989
1.9.11.18.3 BatchConfiguration.......................................................................................................................................... 2991
1.9.11.18.4 Underlay OSFP Routing Protocol................................................................................................................ 2994
1.9.11.18.5 Physical Port Configuration........................................................................................................................... 2998
1.9.11.18.6 Command Configuration Template............................................................................................................ 3004
1.9.12 System Configuration............................................................................................................................................... 3013
1.9.12.1 Northbound Interface............................................................................................................................................3013
1.9.12.1.1 Subscribing to Notifications.............................................................................................................................3013
1.9.12.1.2 Canceling the Notification Subscription...................................................................................................... 3018
1.9.12.1.3 Subscribing To Extended Notifications.........................................................................................................3022
1.9.12.1.4 Canceling the Extended Notification Subscription.................................................................................. 3026
1.9.12.1.5 Querying Subscription Information...............................................................................................................3030
1.9.12.1.6 Subscribing to WebSocket Information Flows.......................................................................................... 3033
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxiii

iMaster NCE-Fabric
1.9.12.1.7 Querying WebSocket Subscription Information....................................................................................... 3035

1.9.12.2 Query Details About the Northbound Floating IP Address of the Active and Standby Clusters 3036
1.9.12.2.1 Query Details About the Northbound Floating IP Address of the Active and Standby Clusters
....................................................................................................................................................................................................... 3037
1.9.12.3 System Information and Product Information Interface........................................................................... 3038
1.9.12.3.1 Obtain System and Product Information.................................................................................................... 3039
1.9.12.4 NetconfClient Northbound API.......................................................................................................................... 3042
1.9.12.4.1 Change the NETCONF User Name and Password................................................................................... 3042
1.9.13 Intent Management.................................................................................................................................................. 3044
1.9.13.1 Fault Rectification................................................................................................................................................... 3045
1.9.13.1.1 Report an Issue.................................................................................................................................................... 3045
1.9.13.1.2 Query Issues.......................................................................................................................................................... 3049
1.9.13.1.3 Query an Issue by ID.......................................................................................................................................... 3053
1.9.13.1.4 Update an Issue by ID....................................................................................................................................... 3055
1.9.13.1.5 Use Ansible to Deliver Configurations to Multiple Devices.................................................................. 3057
1.9.13.2 NAEService................................................................................................................................................................ 3060
1.9.13.2.1 Obtain an End Port............................................................................................................................................. 3060
1.9.13.2.2 Obtain an External Gateway........................................................................................................................... 3063
1.9.13.2.3 Modify the Network Link Change Flag....................................................................................................... 3066
1.9.13.2.4 Query the Network Link Change Flag......................................................................................................... 3067
1.9.13.2.5 Query Device Links on Domain AC by Device ID..................................................................................... 3068
1.9.13.2.6 Get device information (device id, device attribute routerId, vtepIp, etc.)......................................3071
1.9.13.2.7 Obtain the Underlay Network Device Configuration............................................................................. 3073
1.9.13.2.8 Import Configurations to Create a Verification Network...................................................................... 3074
1.9.13.2.9 Import Configurations to Create a What-if Verification Network..................................................... 3077
1.9.13.2.10 Select the Fabric for Which a Verification Network Model Is to Be Created...............................3081
1.9.13.2.11 Query Verification Network Models...........................................................................................................3082
1.9.13.2.12 Delete Verification Network Models.......................................................................................................... 3085
1.9.13.2.13 Export CLI Configuration Data, Version Number, and CPV Model Data....................................... 3086
1.9.13.2.14 Import CLI Configuration Data, Version Number, and CPV Model Data.......................................3089
1.9.13.2.15 Upload Configuration Data for Interconnection Between DCs to the CPV.................................. 3094
1.9.13.2.16 Upload all VPC Configuration Data............................................................................................................3103
1.9.13.3 Network Authentication Request Interface................................................................................................... 3107
1.9.13.3.1 Check Network Connectivity Before and After Overlay Simulation Changes................................ 3107
1.9.13.4 NAE Validation Service......................................................................................................................................... 3119
1.9.13.4.1 Create a Simulation Task.................................................................................................................................. 3119
1.9.13.4.2 Orchestrate a Simulation Task........................................................................................................................ 3123
1.9.13.4.3 Query Simulation Task Details....................................................................................................................... 3125
1.9.13.4.4 Query Configuration and Resources............................................................................................................. 3127
1.9.13.4.5 Delete a Simulation Task.................................................................................................................................. 3131
1.9.13.4.6 Query Simulation Task Details Based on the Task ID.............................................................................3132
1.9.14 Platform Interface...................................................................................................................................................... 3134
1.9.14.1 Resource and Relationship Management.......................................................................................................3134
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxiv

iMaster NCE-Fabric
1.9.14.1.1 Report All Resource and Relationship Data............................................................................................... 3134

1.9.14.1.2 Report Resource or Relationship Changes..................................................................................................3139
1.9.14.1.3 Querying All Instances of a Specified resource Type.............................................................................. 3144
1.9.14.1.4 Query the Number of Instances of a Specified resource Type............................................................ 3151
1.9.14.1.5 Query a Resource Instance.............................................................................................................................. 3154
1.9.14.1.6 Query All Instances of a Type of Relationships by Criteria...................................................................3156
1.9.14.1.7 Query the Number of Instances for a Type Relationship Meeting Criteria.....................................3164
1.9.14.1.8 Query the Instances in a Resource Relationship...................................................................................... 3166
1.9.14.1.9 Run a Graph Query Statement....................................................................................................................... 3168
1.9.14.1.10 Run a graph query statement in replicas................................................................................................. 3171
1.9.14.2 Digital Twin Engine (DTE) Model Management..........................................................................................3173
1.9.14.2.1 Querying Metadata of a Resource Type...................................................................................................... 3173
1.9.14.2.2 Querying Metadata of a Relationship Type............................................................................................... 3175
1.9.14.3 Federated Resource Management.................................................................................................................... 3176
1.9.14.3.1 Adding a Target System.................................................................................................................................... 3177
1.9.14.3.2 (Unavailable)Deleting Target Systems........................................................................................................ 3179
1.9.14.3.3 Starting data synchronization......................................................................................................................... 3181
1.9.14.4 Entity Resource Northbound APIs..................................................................................................................... 3183
1.9.14.4.1 Querying Subrack Resources By Condition.................................................................................................3183
1.9.14.4.2 Querying Optical Port Resources By Condition........................................................................................ 3192
1.9.14.4.3 Querying Port Resources By Condition........................................................................................................ 3196
1.9.14.4.4 Querying Board Resources By Condition.....................................................................................................3207
1.9.14.4.5 Querying Subcard Resources By Condition................................................................................................ 3218
1.9.14.5 Interface Management Northbound APIs...................................................................................................... 3228
1.9.14.5.1 Synchronizing Device Interface Resources.................................................................................................. 3228
1.9.14.5.2 Querying the Interface Synchronization Task Progress..........................................................................3230
1.9.14.5.3 Querying Interface Resources by Condition (Recommended).............................................................3234
1.9.14.5.4 Querying Interface Resources by Condition (Compatible with Earlier Versions)..........................3250
1.9.14.6 DriverMgmt.............................................................................................................................................................. 3259
1.9.14.6.1 Querying Basic Information About a Peer System.................................................................................. 3259
1.9.14.6.2 Adding a Peer System........................................................................................................................................ 3261
1.9.14.6.3 Querying a Peer System....................................................................................................................................3270
1.9.14.6.4 Deleting a Peer System..................................................................................................................................... 3273
1.9.14.6.5 Adding a Domain-IP Address Mapping Relationship..............................................................................3274
1.9.14.6.6 Querying a Domain-IP Address Mapping Relationship..........................................................................3276
1.9.14.6.7 Deleting a Domain-IP Address Mapping Relationship........................................................................... 3278
1.9.14.6.8 Querying Basic Information About Peer Systems.................................................................................... 3280
1.9.14.6.9 Registering Driver Instances (New).............................................................................................................. 3282
1.9.14.6.10 Registering Driver Instances.......................................................................................................................... 3286
1.9.14.6.11 Querying nativeId and systemId of a Peer System............................................................................... 3290
1.9.14.7 Northbound Data Subscription Management.............................................................................................. 3292
1.9.14.7.1 Adding Data Subscription Requests.............................................................................................................. 3293
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxv

iMaster NCE-Fabric
1.9.14.7.2 Querying Subscription Request Information in Batches........................................................................ 3296

1.9.14.7.3 Deleting Data Subscription Requests........................................................................................................... 3298
1.9.14.8 Intent Engine............................................................................................................................................................ 3299
1.9.14.8.1 Create a Service................................................................................................................................................... 3300
1.9.14.8.2 Query All Services............................................................................................................................................... 3308
1.9.14.8.3 Query a Service.................................................................................................................................................... 3317
1.9.14.8.4 Overwrite All Attributes of a Service............................................................................................................ 3320
1.9.14.8.5 Incrementally Modify Some Attributes of a Service................................................................................3323
1.9.14.8.6 Delete a Service................................................................................................................................................... 3326
1.9.14.8.7 Query the Implementation of a Service...................................................................................................... 3328
1.9.14.8.8 Query Service Implementation Nodes in Batches....................................................................................3334
1.9.14.8.9 Query a Request.................................................................................................................................................. 3338
1.9.14.8.10 Retry...................................................................................................................................................................... 3340
1.9.14.8.11 Roll Back.............................................................................................................................................................. 3343
1.9.14.8.12 Synchronize Service Running Status from Controllers/NEs and Check Whether Service
Configurations Are Consistent............................................................................................................................................ 3345
1.9.14.8.13 Synchronize Services to Lower-Layer Controllers/NEs......................................................................... 3350
1.9.14.8.14 Synchronize Services from Lower-Layer Controllers/NEs.................................................................... 3353
1.9.14.8.15 Execute an RPC Request for a Service....................................................................................................... 3355
1.9.14.8.16 Query the Status of an RPC Request......................................................................................................... 3359
1.9.14.9 Configuration File Management....................................................................................................................... 3363
1.9.14.9.1 Import files over the northbound interface............................................................................................... 3363
1.9.14.9.2 Querying All Configuration File Changes................................................................................................... 3367
1.9.14.10 Querying WebSocket Subscription Information........................................................................................ 3371
1.9.14.11 Device Group Management.............................................................................................................................. 3373
1.9.14.11.1 Create a Device Group.................................................................................................................................... 3373
1.9.14.11.2 Delete a Device Group.................................................................................................................................... 3375
1.9.14.11.3 Query All Device Groups................................................................................................................................ 3377
1.9.14.11.4 Query a Device Group..................................................................................................................................... 3380
1.9.14.11.5 Add a Device to a Device Group..................................................................................................................3383
1.9.14.11.6 Delete a Device from a Device Group....................................................................................................... 3386
1.9.14.11.7 Add a Sub Device Group to a Device Group........................................................................................... 3388
1.9.14.11.8 Delete a Sub Device Group from a Device Group................................................................................. 3391
1.9.15 Runbook........................................................................................................................................................................ 3393
1.9.15.1 Runbook Incremental Configuration................................................................................................................3393
1.9.15.1.1 Query Incremental Configurations of a Runbook Instance or a Specified Action Node
(Aggregation Query for Sub-action Nodes Is Supported)........................................................................................ 3393
1.10 Status Code...................................................................................................................................................................... 3397
1.11 Acronyms and Abbreviations..................................................................................................................................... 3398
2 Restconf API Reference....................................................................................................3399

2.1 Neutron............................................................................................................................................................................... 3399
2.1.1 Security Group............................................................................................................................................................... 3399
2.1.1.1 Create a Security Group.......................................................................................................................................... 3399
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxvi

iMaster NCE-Fabric
2.1.1.2 Query Security Groups............................................................................................................................................ 3403

2.1.1.3 Query a Security Group by Name....................................................................................................................... 3406
2.1.1.4 Update a Security Group by Name..................................................................................................................... 3408
2.1.1.5 Deleting a Security Group by Name...................................................................................................................3410
2.1.2 ExternalPolicyGroup.....................................................................................................................................................3411
2.1.2.1 Create an ExternalPolicyGroup............................................................................................................................. 3411
2.1.2.2 Query the External Policy Group List................................................................................................................. 3415
2.1.2.3 External Policy Group Query by Name.............................................................................................................. 3419
2.1.2.4 Update an External Policy Group by Name..................................................................................................... 3421
2.1.2.5 External Policy Group Deletion by Name......................................................................................................... 3423
2.1.3 PolicyTargetGroup........................................................................................................................................................ 3425
2.1.3.1 Create a Policy Target Group................................................................................................................................ 3425
2.1.3.2 Query the Policy Target Group List..................................................................................................................... 3430
2.1.3.3 Policy Target Group Query by Name................................................................................................................. 3434
2.1.3.4 Update a Policy Target Group by Name........................................................................................................... 3436
2.1.3.5 Policy Target Group Deletion by Name............................................................................................................. 3438
2.1.4 IPsec Connection........................................................................................................................................................... 3440
2.1.4.1 Create IPsec Connection......................................................................................................................................... 3440
2.1.4.2 Query IPsec Connection List.................................................................................................................................. 3450
2.1.4.3 Query an IPsec Connection Based on the ID................................................................................................... 3456
2.1.4.4 Update an IPsec Connection Based on the ID.................................................................................................3458
2.1.4.5 Delete an IPsec Connection Based on the ID.................................................................................................. 3461
2.1.5 Security Group Rules................................................................................................................................................... 3462
2.1.5.1 Create a Security Rule............................................................................................................................................. 3462
2.1.5.2 Query Security Rules................................................................................................................................................ 3468
2.1.5.3 Query a Security Rule by Name........................................................................................................................... 3472
2.1.5.4 Delete a Security Rule by Name.......................................................................................................................... 3474
2.1.6 Floating IP Address...................................................................................................................................................... 3476
2.1.6.1 Create a Floating IP Address................................................................................................................................. 3476
2.1.6.2 Query the Floating IP Address List...................................................................................................................... 3481
2.1.6.3 Query a Floating IP Address by Name...............................................................................................................3485
2.1.6.4 Update a Floating IP Address Based on the Name....................................................................................... 3487
2.1.6.5 Delete a Floating IP Address by Name.............................................................................................................. 3489
2.1.7 PolicyClassifier............................................................................................................................................................... 3491
2.1.7.1 Create a Policy Classifier......................................................................................................................................... 3491
2.1.7.2 Query the Policy Classifier List............................................................................................................................. 3496
2.1.7.3 Query Policy Classifiers by Name........................................................................................................................ 3499
2.1.7.4 Update a Policy Classifier by Name.................................................................................................................... 3501
2.1.7.5 Delete Policy Classifier by Name......................................................................................................................... 3503
2.1.8 Port.................................................................................................................................................................................... 3505
2.1.8.1 Creating a port........................................................................................................................................................... 3505
2.1.8.2 Query the Port List................................................................................................................................................... 3519
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxvii

iMaster NCE-Fabric
2.1.8.3 Query a Port by Name............................................................................................................................................ 3529

2.1.8.4 Update Port by Name.............................................................................................................................................. 3532
2.1.8.5 Delete a Port by Name............................................................................................................................................3535
2.1.9 VPNService...................................................................................................................................................................... 3537
2.1.9.1 Create a VPN Service............................................................................................................................................... 3537
2.1.9.2 Query the VPN Service List.................................................................................................................................... 3542
2.1.9.3 Query VPN Service by Name.................................................................................................................................3546
2.1.9.4 Update VPN Service by Name.............................................................................................................................. 3548
2.1.9.5 Delete the VPN Service by Name........................................................................................................................ 3550
2.1.10 DNAT Interface........................................................................................................................................................... 3551
2.1.10.1 Create DNAT.............................................................................................................................................................3551
2.1.10.2 Query the DNAT List............................................................................................................................................. 3558
2.1.10.3 Query DNAT by Name.......................................................................................................................................... 3563
2.1.10.4 Update a DNAT Rule by Name.......................................................................................................................... 3565
2.1.10.5 Deleting a DNAT Rule by Name........................................................................................................................3567
2.1.11 Network......................................................................................................................................................................... 3569
2.1.11.1 Create a Network................................................................................................................................................... 3569
2.1.11.2 Query the Network List........................................................................................................................................ 3575
2.1.11.3 Query a Network by Name................................................................................................................................. 3580
2.1.11.4 Update a Network by Name...............................................................................................................................3582
2.1.11.5 Delete a Network by Name................................................................................................................................ 3585
2.1.12 IPsec policy................................................................................................................................................................... 3586
2.1.12.1 Create an IPsec Policy........................................................................................................................................... 3586
2.1.12.2 Query IPsec Policy List.......................................................................................................................................... 3591
2.1.12.3 Query an IPsec Policy by Name......................................................................................................................... 3594
2.1.12.4 Update an IPsec Policy by Name.......................................................................................................................3596
2.1.12.5 Delete an IPsec Policy by Name........................................................................................................................ 3599
2.1.13 VPC Communication................................................................................................................................................. 3600
2.1.13.1 Create VPC Communication................................................................................................................................ 3600
2.1.13.2 Query the VPC Interworking List....................................................................................................................... 3607
2.1.13.3 Query a VPC Interworking Connection by Name........................................................................................ 3611
2.1.13.4 Update a VPC Interworking Connection by Name......................................................................................3613
2.1.13.5 Delete a VPC Interworking Connection by Name....................................................................................... 3615
2.1.14 PolicyRule...................................................................................................................................................................... 3616
2.1.14.1 Create a Policy Rule............................................................................................................................................... 3617
2.1.14.2 Query a Policy Rule List........................................................................................................................................ 3621
2.1.14.3 Policy Rule Query by Name................................................................................................................................ 3624
2.1.14.4 Update a Policy Rule by Name.......................................................................................................................... 3626
2.1.14.5 Delete a Policy Rule by Name............................................................................................................................ 3628
2.1.15 Router............................................................................................................................................................................. 3630
2.1.15.1 Create a Router....................................................................................................................................................... 3630
2.1.15.2 Query a Router List................................................................................................................................................ 3638
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxviii

iMaster NCE-Fabric
2.1.15.3 Query a Router by Router ID.............................................................................................................................. 3644

2.1.15.4 Update a Router Based on the Router ID...................................................................................................... 3646
2.1.15.5 Delete a Router by Name.................................................................................................................................... 3648
2.1.16 BGP Route..................................................................................................................................................................... 3650
2.1.16.1 Create BGP Route................................................................................................................................................... 3650
2.1.16.2 Query the BGP Route List.................................................................................................................................... 3658
2.1.16.3 BGP Route Query by Name................................................................................................................................. 3663
2.1.16.4 Update BGP Route by Name.............................................................................................................................. 3665
2.1.16.5 Delete a BGP Route by Name............................................................................................................................ 3668
2.1.17 Qos.................................................................................................................................................................................. 3669
2.1.17.1 Create a QoS Policy................................................................................................................................................3669
2.1.17.2 Query the QoS List................................................................................................................................................. 3678
2.1.17.3 Query QoS by Name..............................................................................................................................................3684
2.1.17.4 Update QoS by Name........................................................................................................................................... 3686
2.1.17.5 Delete a QoS Policy by Name............................................................................................................................ 3688
2.1.18 Firewall.......................................................................................................................................................................... 3690
2.1.18.1 Create a Firewall..................................................................................................................................................... 3690
2.1.18.2 Query the Firewall List.......................................................................................................................................... 3695
2.1.18.3 Query a Firewall by Name...................................................................................................................................3699
2.1.18.4 Update a Firewall by Name................................................................................................................................ 3701
2.1.18.5 Delete a Firewall by Name.................................................................................................................................. 3703
2.1.19 Subnet............................................................................................................................................................................ 3705
2.1.19.1 Create Subnets......................................................................................................................................................... 3705
2.1.19.2 Query the Subnet List........................................................................................................................................... 3711
2.1.19.3 Query a Subnet by Name.................................................................................................................................... 3715
2.1.19.4 Update a Subnet by Name.................................................................................................................................. 3717
2.1.19.5 Delete a Subnet by Name....................................................................................................................................3720
2.1.20 FirewallPolicy............................................................................................................................................................... 3721
2.1.20.1 Create a Firewall Policy........................................................................................................................................ 3721
2.1.20.2 Query Firewall Policies.......................................................................................................................................... 3725
2.1.20.3 Query a Firewall Policy by Name...................................................................................................................... 3728
2.1.20.4 Update a Firewall Policy by Name................................................................................................................... 3730
2.1.20.5 Delete a Firewall Policy by Name..................................................................................................................... 3732
2.1.21 L2br................................................................................................................................................................................. 3734
2.1.21.1 Querying Product Version Information........................................................................................................... 3734
2.1.21.2 Create L2BRs.............................................................................................................................................................3736
2.1.21.3 Query the L2BR List............................................................................................................................................... 3741
2.1.21.4 Query L2BRs by Name.......................................................................................................................................... 3746
2.1.21.5 Update an L2BR by Name................................................................................................................................... 3748
2.1.21.6 Delete an L2BR by Name..................................................................................................................................... 3750
2.1.22 PolicyRuleset................................................................................................................................................................ 3752
2.1.22.1 Create a Policy Rule Set........................................................................................................................................3752
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxix

iMaster NCE-Fabric
2.1.22.2 Query a Policy Rule Set List................................................................................................................................ 3755

2.1.22.3 Policy Rule Set Query by Name......................................................................................................................... 3758
2.1.22.4 Update a Policy Rule Set by name................................................................................................................... 3760
2.1.22.5 Delete a Policy Rule Set by Name.................................................................................................................... 3762
2.1.23 Snat................................................................................................................................................................................. 3764
2.1.23.1 Create SNAT............................................................................................................................................................. 3764
2.1.23.2 Query the SNAT List.............................................................................................................................................. 3770
2.1.23.3 Query SNAT by Name........................................................................................................................................... 3774
2.1.23.4 Update the SNAT by Name................................................................................................................................. 3776
2.1.23.5 Delete SNAT by Name.......................................................................................................................................... 3778
2.1.24 Firewall Rules...............................................................................................................................................................3780
2.1.24.1 Create a Firewall Rule........................................................................................................................................... 3780
2.1.24.2 Query Firewall Rules.............................................................................................................................................. 3787
2.1.24.3 Query a Firewall Rule by Name.........................................................................................................................3791
2.1.24.4 Update a Firewall Rule by Name...................................................................................................................... 3793
2.1.24.5 Delete a Firewall Rule by Name........................................................................................................................ 3795
2.1.25 IKE policy....................................................................................................................................................................... 3797
2.1.25.1 Create IkePolicy....................................................................................................................................................... 3797
2.1.25.2 Query the IkePolicy List........................................................................................................................................ 3802
2.1.25.3 Query an IkePolicy by Name.............................................................................................................................. 3805
2.1.25.4 Update IkePolicy by Name.................................................................................................................................. 3807
2.1.25.5 Delete IkePolicy by Name.................................................................................................................................... 3810
2.1.26 ExternalSegmentGroup............................................................................................................................................ 3811
2.1.26.1 Create an External Segment Group..................................................................................................................3811
2.1.26.2 Query the External Segment Group List......................................................................................................... 3817
2.1.26.3 External Segment Group Query by Name..................................................................................................... 3821
2.1.26.4 Update an External Segment Group by Name.............................................................................................3823
2.1.26.5 External Segment Group Deletion by Name................................................................................................. 3825
2.1.27 EndpointGroup............................................................................................................................................................ 3827
2.1.27.1 Create an Endpoint Group................................................................................................................................... 3827
2.1.27.2 Query the Endpoint Group List.......................................................................................................................... 3830
2.1.27.3 Query an Endpoint Group by Name................................................................................................................ 3833
2.1.27.4 Update an Endpoint Group Based on the Name......................................................................................... 3835
2.1.27.5 Delete an Endpoint Group by Name................................................................................................................3837
2.1.28 Extended Routing Interface.................................................................................................................................... 3839
2.1.28.1 Create an Extended Route................................................................................................................................... 3839
2.1.28.2 Delete Extended Routes....................................................................................................................................... 3845
2.1.28.3 Query: Local-vtepip................................................................................................................................................ 3848
2.1.29 Hierarchical Binding.................................................................................................................................................. 3851
2.1.29.1 Hierarchical Binding............................................................................................................................................... 3851
2.1.30 Ipv6NsQos..................................................................................................................................................................... 3856
2.1.30.1 Create IPv6 QoS...................................................................................................................................................... 3856
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxx

iMaster NCE-Fabric
2.1.30.2 Query the IPv6 QoS List....................................................................................................................................... 3860

2.1.30.3 Query IPv6 QoS by Name.................................................................................................................................... 3863
2.1.30.4 Update IPv6 QoS by Name................................................................................................................................. 3865
2.1.30.5 Delete IPv6 QoS by Name................................................................................................................................... 3867
2.1.31 Alarms............................................................................................................................................................................ 3869
2.1.31.1 Trigger a Trap........................................................................................................................................................... 3869
2.2 Northbound Data Collection........................................................................................................................................ 3872
2.2.1 Start Northbound Data Collection..........................................................................................................................3872
2.2.2 Query the Northbound Data Collection Status..................................................................................................3876
2.2.3 Obtain Northbound Collected Data....................................................................................................................... 3879
2.3 Intent Engine..................................................................................................................................................................... 3880
2.3.1 Create a Process Instance.......................................................................................................................................... 3881
2.3.2 Query Process Instances in Batches....................................................................................................................... 3887
2.3.3 Query a Process Instance........................................................................................................................................... 3896
2.3.4 Delete a Process Instance.......................................................................................................................................... 3899
2.3.5 Retry a Process Instance............................................................................................................................................. 3902
2.3.6 Roll Back a Process Instance..................................................................................................................................... 3905
2.3.7 Execute a Process Instance........................................................................................................................................ 3909
2.3.8 Suspend a Process Instance...................................................................................................................................... 3913
2.3.9 Query the Result Details of a Process Instance................................................................................................. 3916
2.4 Query Inventory Device Status.................................................................................................................................... 3919
2.4.1 Query the Status of All NEs...................................................................................................................................... 3919
2.4.2 Query the NE Status Based on the NE ID............................................................................................................ 3921
2.4.3 Query NE Interface Information..............................................................................................................................3923
2.5 Query Inventory Device Information.........................................................................................................................3924
2.5.1 Query All NE Information.......................................................................................................................................... 3924
2.5.2 Query NE Information Based on the NE ID.........................................................................................................3929
2.5.3 Query NE Interface Information Based on the NE ID...................................................................................... 3930
2.6 OMPub Service-System Information......................................................................................................................... 3932
2.6.1 Query System NCD Information..............................................................................................................................3932
2.7 OMPub Service-Geographic Redundancy Cluster Active/Standby Status.................................................... 3935
2.7.1 Query the Active/Standby DR Cluster Status...................................................................................................... 3935
2.8 OpenFlow Interface......................................................................................................................................................... 3937
2.8.1 Query the OpenFlow Version................................................................................................................................... 3937
2.9 System Information and Product Information Interface.................................................................................... 3939
2.9.1 Obtain System and Product Information............................................................................................................. 3939
2.10 User Authentication Service....................................................................................................................................... 3943
2.10.1 Obtain a Token( V1 )................................................................................................................................................ 3943
2.10.2 Delete a Token( V1 )................................................................................................................................................. 3946
2.10.3 Obtaining a Token by a Third-Party System ................................................................................................... 3948
2.11 Northbound Notification Service-Websocket...................................................................................................... 3952
2.11.1 Create a Subscription Stream................................................................................................................................ 3952
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxxi

iMaster NCE-Fabric
2.11.2 Obtain the URL of the Actual Subscription Notification (Message in XML Format)......................... 3955
2.11.3 Obtain the URL of the Actual Subscription Notification (Message in JSON Format)........................3957
2.11.4 Notification Event Query Within a Specified Period...................................................................................... 3958
2.12 Configuration Transaction API Provided by the Southbound Service..........................................................3960
2.12.1 Overview....................................................................................................................................................................... 3960
2.12.1.1 URI Prefix................................................................................................................................................................... 3960
2.12.1.2 URI Format................................................................................................................................................................ 3961
2.12.1.3 Status Codes............................................................................................................................................................. 3962
2.12.1.4 Error Information.................................................................................................................................................... 3963
2.12.2 Development Example............................................................................................................................................. 3964
2.12.2.1 POST Operation.......................................................................................................................................................3965
2.12.2.2 PUT Operation......................................................................................................................................................... 3966
2.12.2.3 DELETE Operation.................................................................................................................................................. 3967
2.12.2.4 GET Operation......................................................................................................................................................... 3967
2.12.3 API................................................................................................................................................................................... 3968
2.12.3.1 Service Management............................................................................................................................................. 3968
2.12.3.1.1 AOC Northbound API......................................................................................................................................... 3968
2.12.3.1.2 Asynchronous Restoration northbound API of the AOC........................................................................4013
2.12.3.1.3 CLI northbound transparent transmission.................................................................................................. 4043
2.12.3.1.4 Service Consistency............................................................................................................................................. 4049
2.12.3.1.5 Northbound Consistency Collection..............................................................................................................4075
2.12.3.1.6 AOC Device Group Inventory Information API..........................................................................................4085
2.12.3.1.7 AOC commit manager....................................................................................................................................... 4104
2.12.3.1.8 Service Consistency............................................................................................................................................. 4112
2.12.3.2 Device Management.............................................................................................................................................. 4135
2.12.3.2.1 Consistency verification for southbound data...........................................................................................4135
2.12.3.2.2 Device configuration history............................................................................................................................4181
2.12.3.2.3 AocUniRealDeviceRpc........................................................................................................................................ 4215
2.12.3.2.4 AocUniRealDeviceQuery................................................................................................................................... 4219
2.12.3.3 Template Management........................................................................................................................................ 4223
2.12.3.3.1 AOC Template Parameter Northbound API............................................................................................... 4224
2.12.3.3.2 AOC Configuration Template Application Northbound Interface...................................................... 4239
2.12.3.3.3 Northbound API for AOC configuration templates................................................................................. 4276
2.12.3.3.4 AOC Device Template Northbound API....................................................................................................... 4305
2.12.3.4 Resource Management......................................................................................................................................... 4321
2.12.3.4.1 HuaweiNceResourcePoolManager................................................................................................................ 4321
2.13 Notification Reference................................................................................................................................................. 4348
2.13.1 Base Inventory Info (huawei-ac-inventory-base.yang)................................................................................. 4348
2.13.1.1 add-ne........................................................................................................................................................................ 4348
2.13.1.2 ltp-down-clear......................................................................................................................................................... 4352
2.13.1.3 ltp-down.................................................................................................................................................................... 4353
2.13.1.4 add-ltp........................................................................................................................................................................ 4356
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxxii

iMaster NCE-Fabric
2.13.1.5 synchronize-status-change.................................................................................................................................. 4359

2.13.2 Inventory Info (huawei-ac-inventory.yang).......................................................................................................4360
2.13.2.1 ne-down-clear..........................................................................................................................................................4360
2.13.2.2 ne-down..................................................................................................................................................................... 4361
2.13.3 Device Interface Management (huawei-ac-net-interface.yang)................................................................4362
2.13.3.1 interface-attributes-change................................................................................................................................ 4362
2.13.3.2 interface-ip-change................................................................................................................................................ 4364
2.13.4 Topology Management (huawei-ac-network-topology.yang).................................................................... 4366
2.13.4.1 node-down-clear.....................................................................................................................................................4366
2.13.4.2 add-link...................................................................................................................................................................... 4368
2.13.4.3 node-down................................................................................................................................................................ 4374
2.13.4.4 link-down................................................................................................................................................................... 4376
2.13.4.5 link-down-clear........................................................................................................................................................4378
3 Cloud Plug-in API Reference.......................................................................................... 4380

3.1 BGP Route........................................................................................................................................................................... 4380
3.1.1 Create BGP Route......................................................................................................................................................... 4380
3.1.2 Create a BGP Peer........................................................................................................................................................ 4388
3.1.3 Query the BGP List....................................................................................................................................................... 4394
3.1.4 Update BGP Peers........................................................................................................................................................ 4396
3.1.5 Delete BGP Peers.......................................................................................................................................................... 4399
3.2 Extended Route................................................................................................................................................................. 4401
3.2.1 Add Extended Routes.................................................................................................................................................. 4401
3.2.2 Delete Extended Routes............................................................................................................................................. 4406
3.2.3 Query Information About Extended Routes........................................................................................................ 4409
3.3 VPC Connection APIs...................................................................................................................................................... 4410
3.3.1 Create VPC Connections............................................................................................................................................. 4410
3.3.2 Obtain All VPC Connections......................................................................................................................................4421
3.3.3 Obtain Details About a VPC Connection.............................................................................................................. 4423
3.3.4 Update a VPC Connection......................................................................................................................................... 4425
3.3.5 Delete VPC Connections............................................................................................................................................. 4428
3.4 SNAT Interface.................................................................................................................................................................. 4429
3.4.1 Create SNAT................................................................................................................................................................... 4429
3.4.2 Update SNAT..................................................................................................................................................................4436
3.4.3 Delete SNAT................................................................................................................................................................... 4439
3.5 L2BR...................................................................................................................................................................................... 4440
3.5.1 Create L2BRs in Batches............................................................................................................................................. 4440
3.5.2 Update L2BRs in Batches........................................................................................................................................... 4449
3.5.3 Delete L2BRs in Batches............................................................................................................................................. 4452
3.5.4 Create an L2BR.............................................................................................................................................................. 4454
3.5.5 Query All L2BRs.............................................................................................................................................................4457
3.5.6 Query an L2BR by ID................................................................................................................................................... 4460
3.5.7 Update an L2BR by ID.................................................................................................................................................4461
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxxiii

iMaster NCE-Fabric
3.5.8 Delete an L2BR by ID.................................................................................................................................................. 4464

3.6 VPC Connection API_2.................................................................................................................................................... 4465
3.6.1 Create VPC Connections............................................................................................................................................. 4466
3.6.2 Update a VPC Connection......................................................................................................................................... 4474
3.6.3 Delete VPC Connections............................................................................................................................................. 4480
3.7 BGPNeighbor..................................................................................................................................................................... 4481
3.7.1 Create a BGP Peer........................................................................................................................................................ 4481
3.7.2 Query the BGP List....................................................................................................................................................... 4485
3.7.3 Query Detailed BGP Information............................................................................................................................ 4487
3.7.4 Update BGP Peers........................................................................................................................................................ 4488
3.7.5 Delete BGP Peers.......................................................................................................................................................... 4492
3.8 Extended Route exroute_custom................................................................................................................................ 4493
3.8.1 Add Extended Routes.................................................................................................................................................. 4494
3.8.2 Delete Extended Routes............................................................................................................................................. 4497
3.8.3 Query Information About Extended Routes........................................................................................................ 4500
3.9 Compare_result................................................................................................................................................................. 4501
3.9.1 Query Neutron Compare Results............................................................................................................................ 4501
3.10 Sync_result....................................................................................................................................................................... 4504
3.10.1 Query neutron sync results..................................................................................................................................... 4504
3.11 Egress Whitelist.............................................................................................................................................................. 4507
3.11.1 Create an Egress Whitelist...................................................................................................................................... 4507
3.11.2 Query the Egress Whitelist......................................................................................................................................4510
3.11.3 Query Details About an Egress Route Whitelist.............................................................................................. 4511
3.11.4 Update the Egress Whitelist................................................................................................................................... 4513
3.11.5 Delete an Egress Whitelist...................................................................................................................................... 4515
3.11.6 Add an Extended Route Prefix to the Egress Whitelist................................................................................. 4517
3.11.7 Delete the Extended Route Prefix from the Egress Whitelist..................................................................... 4519
3.11.8 Add a Subnet to the Egress Whitelist................................................................................................................. 4520
3.11.9 Delete a Subnet from the Egress Whitelist....................................................................................................... 4522
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxxiv

iMaster NCE-Fabric
API Development Guide 1 RESTFul API Reference
1 RESTFul API Reference
1.1 Interface Overview

1.2 Common Interface Mechanisms
1.3 Common Interface Information
1.4 Prerequisites
1.5 Service Model
1.6 Interface Invocation Process
1.7 Authentication Interface
1.8 SNMP
1.9 Interface Reference
1.10 Status Code
1.11 Acronyms and Abbreviations
1.1 Interface Overview

The iMaster NCE-Fabric can interconnect with the OpenStack by default. RESTful
northbound interfaces can be used to interconnect with cloud platforms. This
document describes the interconnection methods.
The cloud platform accesses the iMaster NCE-Fabric through Neutron APIs. To use
the interfaces, you must construct and configure the environment. This document
provides open iMaster NCE-Fabric northbound APIs for secondary development.
Configurations created using APIs cannot be modified or deleted on the web page
of iMaster NCE-Fabric (except tenant creation).
1.2 Common Interface Mechanisms
Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. 1

iMaster NCE-Fabric
1.2.1 Token Obtaining

Sample Request
HTTP
POST /controller/v2/tokens HTTP/1.1
Host: 192.168.1.125:18002
Content-Type: application/json
Accept: application/json
{
"userName" : "Account of the northbound interface operator",
"password" : "Password of the northbound interface operator"
}
192.168.1.125 and 18002 are the northbound floating IP address and port number
of the controller. Set the northbound floating IP address based on the site
requirements. The port number is fixed to 18002.
Request Parameters
Table 1-1 body parameters

Paramet Mandat Type Value Default Description
er ory Range Value
authCredi Yes REFEREN For details, see Table Obtaining the token
t CE 1-2. input parameter.
Table 1-2 authCredit parameters

er ory Range Value
userNam No string 1 to 128 - User name.

e character
s.

iMaster NCE-Fabric

er ory Range Value
password No string 5 to 128 - This field may

character contain sensitive
s. data. Properly
encrypt the field.
Typical sensitive
data includes
authentication
credentials (such as
passwords, dynamic
tokens, and SMS
random passwords),
bank accounts, a
large amount of
personal data, and
communication
content.
User password.
Sample Response
● Response status code 200: OK.
HTTP/1.1 200 OK
Date: Tue,30 Oct 2018 10:00:00 GMT
Server: example-server
Content-Type: application/json;charset=UTF-8
Content-Length: 250
Connection: keep-alive
{
"data" : {
"token_id" : "**************************************************",
"expiredDate" : "2018-10-30 10:09:23"
},
"errcode" : "0",
"errmsg" : "get token successfully."
}
● Response status code 401: Unauthorized error.

For details, see the response message body.
Response Parameters
Response status code 200: OK.
Table 1-3 AuthTokenV2Out parameters
Parameter Type Value Default Description

Range Value
data ARRAY_REF For details, see Table 1-4. -

ERENCE

iMaster NCE-Fabric

Range Value
errcode string 0 to 128 - Error code.

characters.
errmsg string 0 to 128 - Error information.

characters.
Table 1-4 data parameters

Range Value
token_id string 0 to 1024 - Token ID.

characters. This field may
contain sensitive
data. Properly encrypt
the field. Typical
sensitive data
includes
authentication
credentials (such as
passwords, dynamic
tokens, and SMS
random passwords),
bank accounts, a
large amount of
personal data, and
communication
content.
expiredDate string 0 to 128 - Token timeout time,

characters. in the format yyyy-
MM-dd HH:mm:ss.
1.2.2 URL Format

http(s)://IP:port/controller/product/version/interface type/{module name}
● Supported products: dc
● Version: v2
● Interface type: neutronapi
● Module name: for example, network, subnet
● Parameter description:
– IP: indicates the IP address of the iMaster NCE-Fabric.
– port: 18002 indicates the port number. For example, in https://
192.168.2.2:18002.

iMaster NCE-Fabric
The values of the URL fields (product, version, interface type, and module name)
are case-sensitive.
URL for a DC's northbound interface: http(s)://IP:port/controller/dc/v2/interface
type/{module name}
Default URL for the iMaster NCE-Fabric's northbound interface: https://IP:18002/
controller/dc/v2/interface type/{module name}
1.2.3 Returned Response Value

Normal response values:
● The status code 201 is returned if the POST operation succeeded.
● The status code 204 is returned if the DELETE operation succeeded.
● The status code 200 is returned if the GET operation succeeded.
● The status code 200 is returned if the PUT operation succeeded.
Special response values:
● The status code 208 is returned if the object ID already exists but the content
differs during creation. The status code 201 is returned if the object content
duplicates.
● The status code 400 is returned if the object ID does not exist during
updating.
● The status code 404 is returned if the object ID does not exist during query.
● The status code 204 is returned if the object ID does not exist during deletion.
● The URL format is context_path/path. The status code 404 is returned if
context_path or path does not exist.
1.2.4 service_name
The iMaster NCE-Fabric supports the service_name field for northbound
interfaces. The field type is string, and has 1 to 255 bytes. This field indicates a
cloud platform name. This field is mandatory during service provisioning through
a northbound interface. The iMaster NCE-Fabric can distinguish services from
different cloud platforms based on the field.
The following example describes how to create a network.
{
"service_name": "openstack11",
"network":
{
"shared": "false",
"name": "liudongtest",
"admin_state_up": "true",
"tenant_id": "6fbe9263116a4b68818cf1edce16bc4"

iMaster NCE-Fabric
}
}
The service_name field is mandatory for the creation operation of all modules
through the Neutron APIs.
L2/L3: subnet, network, port, router, router interface
L4-L7: all services
1.3 Common Interface Information

REST Description
Definition of REST
Representational State Transfer (REST) is a software architecture style. RESTful
web services are simpler than SOAP-based and XML-RPC-based web services
which are the other two main web services. Therefore, more and more web
services are designed and implemented in the REST style.
Description of Common HTTP Request Modes
● GET
Obtain detailed information about specified resources. You can choose an
Internet media type as needed (for example, XML and JSON). This document
uses the JSON type.
● PUT
Update a specified element.
● POST
Treat URI as a resource group and create a new element in it.
● DELETE
Delete a specified element.
Interface Description
● Interface access path:
https://{ip}:{port}/controller/dc/v2.0/neutronapi/{module name}
If HTTPS is used, the port number is 18002.
Sample:
https://{ip}:{port}/controller/dc/v2.0/neutronapi/networks
NOTE
HTTP and HTTPS are supported, and HTTPS is recommended. In all the sample interface
URIs, HTTPS is used.
● HTTP request mode:
POST/GET/DELETE/PUT
● Parameter format:
application/json;charset=UTF-8

iMaster NCE-Fabric
NOTE
All parameter formats are application/json;charset=UTF-8 and will not be described

here.
● HTTP header parameters
All interfaces (except the authentication interface) must add the following
three parameters to the header before being invoked.
Key Value
Content-Type application/json
Accept application/json
X-ACCESS-TOKEN Token ID obtained from the

authentication interface.
Parameter Type Description
Table 1-5 Parameter Type Description
Parameter Description
Content-Type Indicates the format of data in the

entity header.
Accept Indicates the type of data in the

request header.
X-ACCESS-TOKEN Indicates the variable name of TOKEN

in the HTTP header.
application/json Indicates that the JSON format is

supported.
CRUD Description
In computing, CRUD is an acronym for create, retrieve, update, and delete. It refers
to the basic operations of a database or persistence layer in a software system.
CRUD indicates that this parameter can be manually entered in the operation. The
value of Mandatory or Not can be as follows:
● Yes indicates that this parameter is mandatory for all operations.

● No indicates that this parameter is optional for all operations.
● For an operation that belongs to CRUD, the parameter is mandatory for the
corresponding operation.
For example, in the object model of a network, the parameter tenantId can be
manually entered during network creation and query, and is mandatory during
network creation.

iMaster NCE-Fabric
Parameter Type Mandatory CRUD Description

or Not
status string No R Network status. The

default value is
ACTIVE.
subnets list(uuid-str) No R List of subnets on a

network.
name string No CRU Network name. The

maximum length is
255 bytes.
routerExternal bool C CR Extended attribute

specifying whether
the route is an
external route.
The default value is
false, indicating that
the route is not an
external route.
adminStateUp bool No CRU Administrative

status. The default
value is true.
tenantId string C CR Tenant ID. Only an

administrator can
specify tenantId for
other tenants.
The maximum
length is 255 bytes.
Sample:
POST /controller/dc/v2/neutronapi/networks
{
"network":
{
"status": "ACTIVE",
"subnets": null,
"name": "network_test",
"routerExternal": "false",
"adminStateUp": "false",
"tenantId": "7ce8490f-cf5f-411f-b3e5-d576dfdc7330",
"shared": "false",
"id": "00000000-0000-0000-0000-000000000004",
"physicalNetwork": "physnet1",
"networkType": "vlan",
"segmentationId": 2006
},
"serviceName":"physnet1"

iMaster NCE-Fabric
If the request body for creating networks does not contain tenantId, the network
creation operation fails.
1.4 Prerequisites
Table 1-6 Prerequisites for global services
Prerequisites for global services
● A northbound interface account has been created and the password has been
changed.
● Devices have been discovered.
● A fabric has been created and devices have been added.
● An L4-L7 resource pool has been created and associated with the fabric.
Devices have been added to the VAS pool.
● Links have been discovered automatically or created manually.
● Host access links have been created.
● Internal and external links have been configured for firewalls.
● Global resources have been created.
● A cloud platform has been created.
● External gateways have been configured on the iMaster NCE-Fabric.
Table 1-7 Prerequisites for each service
Service Module Prerequisites

Name
Routers ● Networks and subnets have been created.
Static route ● Networks, subnets, and external gateways have been

created.
Networks -
Ports ● Networks, subnets, and security groups have been

created.
QoS ● Networks and subnets have been created.
Security groups ● Networks, subnets, and ports have been created.
Security group rules ● Networks, subnets, and ports have been created.
● Security groups have been created.
Firewalls ● Networks, subnets, routers, and gateway ports have

been created.
● Firewall rules have been created.
● Firewall policies have been created.

iMaster NCE-Fabric
Service Module Prerequisites

Name
Firewall policies ● Networks have been created.

● Firewall rules have been created.
Firewall rules ● Networks have been created.
Floating IP address ● Networks, subnets, routers, and gateway ports have

been created.
IPSec site connection ● Networks, subnets, routers, and gateway ports have
been created.
● SNAT has been set to true for updating a router.
● IKE policies, IPsec policies, router interfaces, and VPN
services have been created.
● An IPsec site connection has been created.
VPN service ● Internal and external links, global resources, cloud

platforms, networks, subnets, routers, and gateway
ports have been created.
● Router interfaces and VPN services have been created.
IKE policies ● Networks, subnets, routers, and gateway ports have

been created.
● IKE policies have been created.
IPSec policies ● Networks, subnets, routers, and gateway ports have

been created.
● IPsec policies have been created.
Internal router ● Networks, subnets, and routers have been created.

interfaces
SNAT ● Networks, subnets, routers, and gateway ports have

been created.
1.5 Service Model

Service Model
Figure 1-1 shows the service model of the iMaster NCE-Fabric and the
relationships between the project and all service modules.

iMaster NCE-Fabric
Instances and projects are created on the cloud management platform directly
instead of through the RESTful interfaces. Port management interface on the
RESTful is used when creating instances to assign VMs to use the ports.
All the other service modules are created through invoking the RESTful interfaces.
Figure 1-1 Service Model
Interface Mappings
Table 1-8 describes the mappings between all service modules and the RESTful
interfaces.
Table 1-8 Mappings between service modules and the RESTful interfaces
Service Description Interface Access Path

Module
Router Virtual routers are used for https://{ip}:{port}/

interconnection between controller/dc/v2/neutronapi/
subnets and accessing routers
external networks.
Static route Static route is manually https://{ip}:{port}/

configured by the controller/dc/v2/neutronapi/
administrator because it routers/{router_id}/add_routes
cannot automatically adapt to
network topology changes.

iMaster NCE-Fabric

Module
Network Indicates an isolated Layer 2 https://{ip}:{port}/

network domain. Hosts in one controller/dc/v2/neutronapi/
network are visible at a Layer networks
2 network.A user can have
multiple networks. Subnets
and ports must be associated
with networks which are the
basis. VXLAN and VLAN are
supported.
Subnet A subnet indicates a network https://{ip}:{port}/

segment. Each subnet has a controller/dc/v2/neutronapi/
CIDR and is associated with a subnets
network. The IP address can
be selected from the CIDR or
a specified pool. A subnet
may have a gateway, a group
of DNSs, and host routes.
Subnets are invisible at a
Layer 2 network and
communicate with each other
through Layer 3 routing by
passing through a Layer 3
gateway (router). A network
supports only one subnet.
Port A port belongs to a network https://{ip}:{port}/

and indicates a network controller/dc/v2/neutronapi/ports
access point which is used to
connect VMs or routers. The
NICs of VMs are connected to
the port and the VMs access
the network using the port. If
an IP address is bound to the
port, the port belongs to a
subnet.
QoS Indicates quality of services. https://{ip}:{port}/

QoS is a security mechanism controller/dc/v2/neutronapi/qoss
for resolving network delay
and congestion. When a
network is overloaded or
congested, QoS can ensure
that important services are
processed and ensure the
efficient running of the
network. Currently, QoS
supports only rate limit.

iMaster NCE-Fabric

Module
Security Trust VMs communicate with https://{ip}:{port}/

group each other through security controller/dc/v2/neutronapi/
groups on the OpenStack. security-groups
VMs in the same security
group use the same security
policies. A security group
works on a VM port and is a
port-level virtual firewall. It
filters incoming and outgoing
port traffic.
Security Indicates the policy for https://{ip}:{port}/

group rule implementing traffic filtering. controller/dc/v2/neutronapi/
One security group can have security-group-rules
multiple security group rules.
Firewall Firewall is a series of https://{ip}:{port}/

components deployed among controller/dc/v2/neutronapi/fw/
multiple networks or security firewalls
zones. The firewall monitors,
restricts, and modifies data
flows passing through it to
protect network security.
Firewall In the Neutron system, a https://{ip}:{port}/

policy firewall policy is a list of rules controller/dc/v2/neutronapi/fw/
arranged in a specific firewall_policies
sequence.
Firewall Check whether traffic is https://{ip}:{port}/

rule allowed to pass based on controller/dc/v2/neutronapi/fw/
firewall rules. firewall_rules
Floating IP Binds the IP of the specified https://{ip}:{port}/

address VM. The external network can controller/dc/v2/neutronapi/
access the VM through floatingips
floating IP.
IPSec site The connection object defines https://{ip}:{port}/

connection the routing method controller/dc/v2/neutronapi/vpn/
connecting sites, key method, ipsec-site-connections
authentication mode,
parameters, and service
subnets. Ipsecsiteconn is used
for creating IPSec tunnels
between two networks to
implement LAN
communication.

iMaster NCE-Fabric

Module
VPN Virtual private network (VPN) https://{ip}:{port}/

service is built on a public network controller/dc/v2/neutronapi/vpn/
for encrypted communication. vpnservices
The VPN gateway enables
remote access through data
encryption and address
translation.
IKE policy The IKEPolicy object defines https://{ip}:{port}/

parameters for IKE controller/dc/v2/neutronapi/vpn/
negotiation in the first phase ikepolicies
IPSec policy The IPSecPolicy object defines https://{ip}:{port}/

parameters for ESP controller/dc/v2/neutronapi/vpn/
negotiation in the second ipsecpolicies
phase.
Router Indicates a port connected to https://{ip}:{port}/

interfaces a router. The port is a controller/dc/v2/neutronapi/
gateway of a subnet. routerinterface/{router_id}/
add_router_interface
SNAT Source network address https://{ip}:{port}/

translation, used to translate controller/dc/v2/neutronapi/snat
the source address of an IP
data packet to another
address.
L2br Layer 2 bridge, providing the https://{ip}:{port}/

layer 2 bridge between VXLAn controller/dc/v2/neutronapi/l2brs
virtual machine and VLAn
physical server.
1.6 Interface Invocation Process
1.6.1 Overall Configuration Process

Service Requests
The following table describes the basic service requests of users.
Table 1-9 Service requests (for VMs only)
Communication mode Network access
Communication between intranets and Internet access

extranets (through firewalls)
External private network access

iMaster NCE-Fabric
Communication mode Network access
Communication between intranets On the same VPC (the data does not
pass through firewalls)
On different VPCs (the data passes

through firewalls)
Special services:
● VPN access: An access mode for communication between intranets and

external private networks. VPN service can be configured independently after
the basic network services (including networks, subnets, ports, and VMs) have
been configured at L2 and L3. For details, see 1.6.4 Communication Between
an Intranet and an External Private Network Through IPSec VPN.
NOTE
● L2 refers to the data link layer at the second layer of the OSI model. At L2, data is
transmitted based on MAC addresses.
● L3 refers to the network layer at the third layer of the OSI model. At L3, data is
transmitted based on IP addresses.
If port rate limiting or traffic limiting is required, port QoS needs to be configured.
Basic Networking
Figure 1-2 Basic networking

iMaster NCE-Fabric
Overall Configuration Process

Figure 1-3 shows the overall configuration process of the preceding four basic
service requests.
Figure 1-3 Overall configuration process
Only tenant's networks need to be created by invoking the eSDK interface and all
the other steps can be performed on the cloud platform directly. This document
describes the configuration process of creating tenant's networks.
The configuration process varies as users' requests are different. The details are as
follows:
● Communication between the intranet and the Internet: For detailed
configuration process, see 1.6.2 Communication Between an Intranet and
the Internet.
● Communication between the intranet and an external private network: For
detailed configuration process, see 1.6.4 Communication Between an
Intranet and an External Private Network Through IPSec VPN.
● Communication between VPCs: For detailed configuration process, see 1.6.5
Communication Between VPCs.
● Communication within a VPC: For detailed configuration process, see 1.6.6
Communication Within a VPC.

iMaster NCE-Fabric
● Traffic limiting of VMs using security groups: For details, see 1.6.7 Traffic
Limiting of VMs Using Security Groups.
1.6.2 Communication Between an Intranet and the Internet

Flowchart
Figure 1-4 shows the configuration process of connecting an intranet to the
Internet.
Figure 1-4 Flowchart of connecting an intranet to the Internet

iMaster NCE-Fabric
Reference Interface and Description
Table 1-10 Reference interface and description

Tasks Reference interface and description
Creating a router Router management interface
Creating a network and subnets Network management interface and subnet

management interface
Creating a route interface to Router management interface

associate the subnets with the
router
(Optional) Creating a security Security group management interface

group and configuring rules You can specify a security group when
creating instances to enable intranet
communication for the instances in one
security group.
Creating an instance to connect Port management interface

VMs to the network
Configuring the gateway and Source NAT interface

selecting external networks
Creating a firewall, selecting Firewall management interface

policies, and associating them
with the router
Binding floating IP addresses, Floating IP address interface

starting from extranets to
intranets
1.6.3 Load balancing of Traffic from the Internet Using an LB

Flowchart
Figure 1-5 shows the flowchart for load balancing of traffic from the Internet
using an LB.

iMaster NCE-Fabric
Figure 1-5 Load balancing of traffic from the Internet using an LB
Creating a network and subnets Network management interface and

subnet management interface
Creating a port Port management interface
Creating a load balancing port Port management interface
Creating a load balancer Load balancer management interface
Creating a load balancing listener Interface for managing a load

balancing listener

iMaster NCE-Fabric
Creating a load balancing resource Interface for managing load balancing

pool resource pool
Creating load balancing resources Interface for managing load balancing

resources
Creating a load balancing resource Interface for managing load balancing

monitor resource monitor
1.6.4 Communication Between an Intranet and an External

Private Network Through IPSec VPN
Flowchart
Figure 1-6 shows the configuration process of connecting an intranet to external
private networks.

iMaster NCE-Fabric
Figure 1-6 Flowchart of connecting an intranet to external private networks

iMaster NCE-Fabric



router

security group.

VMs to the network
Configuring the gateway and Distributed router management interface

selecting external networks
Creating a firewall, selecting Firewall management interface

policies, and associating them
with the router
(Optional) Creating a VPN service IPSec VpnaaS service interface

Perform this step only when the service
request involves VPN access.
1.6.5 Communication Between VPCs

Flowchart
Figure 1-7 shows the configuration process of connecting intranets on different
VPCs.

iMaster NCE-Fabric
Figure 1-7 Flowchart of connecting intranets on different VPCs

iMaster NCE-Fabric


Creating a route interface to associate Router management interface

the subnets with the router
(Optional) Creating a security group Security group management interface

and configuring rules You can specify a security group when
communication for the instances in
one security group.
Creating an instance to connect VMs Port management interface

to the network
Creating a firewall, selecting policies, Firewall management interface

and associating them with the router
Configuring the route between the Static route management interface

corresponding firewalls of the two
VPCs (vRouters)
1.6.6 Communication Within a VPC

Flowchart
Figure 1-8 shows the configuration process of connecting intranets on the same
VPC.

iMaster NCE-Fabric
Figure 1-8 Flowchart of connecting intranets on the same VPC



router

iMaster NCE-Fabric

security group.

VMs to the network
1.6.7 Traffic Limiting of VMs Using Security Groups

Flowchart
Figure 1-9 shows process of traffic limiting of VMs using security groups.
Figure 1-9 Traffic limiting of VMs using security groups

iMaster NCE-Fabric

Creating a security group Security group management interface
(Optional) Creating a security Security group rule management interface

group rule
Creating a port Port management interface
1.6.8 Configuring HIROERService Interface Blacklists

If there are interfaces of the service plane under external attacks (for example,
attacked when the service plane is accessed from a browser), you can add risky
interfaces to HIROERService interface blacklists to prevent external attacks. The
service functions of the interfaces added to the HIROERService interface blacklists
are unavailable. You need to delete them from the HIROERService interface
blacklists to restore these interfaces and their service functions.
Prerequisites
● You have logged in to the management plane.
● You have obtained the passwords for the sopuser, ossuser, and ossadm users
of the node where the hiroer process instance resides. If the service plane is
deployed in cluster mode, you need to obtain the passwords for the sopuser,
ossuser, and ossadm users of the nodes where the active and standby hiroer
process instances reside.
Procedure
Step 1 Modify the configuration parameters to enable the blacklist configuration
function.
1. On the management plane, choose Product > Software Management >
Deploy Product Software from the main menu.
2. On the Deploy Product Software page, click the product with configurations
to be modified. The page for the product details is displayed.
3. In the upper right corner of the page, click More and choose Modify
Configurations from the drop-down menu.
NOTE
Exercise caution when performing this operation. Incorrect parameters may cause
configuration failures or even system unavailability.
4. Set enableBlacklist to true and perform operations as prompted.

iMaster NCE-Fabric
NOTE
If the default value of enableBlacklist is true, skip this step.
Step 2 Configure interface blacklists.

1. Use PuTTY to log in to the node where the active hiroer process instance of
HIROERService resides, as the sopuser user in SSH mode. For details about
how to check the active/standby status and IP address of a process instance,.
NOTE
If the service plane is deployed in single-server mode, log in to the node where the
hiroer process instance resides. For details about how to obtain the IP address of the
node where the hiroer process instance resides.
2. Run the following command to switch to the ossuser user:
su - ossuser
Password: password for the ossuser user
3. Run the following command to switch to the directory that stores the
hiro_tool script:
cd /opt/oss/SOP/apps/HIROERService/init
4. Run the following command to import environment variables:
source hiro_tool.sh
5. Perform operations by referring to Table 1-16.

iMaster NCE-Fabric
Table 1-16 Configuring the interface blacklist

Task Operation
Adding – Adding an interface to the interface blacklist for prefix

interfaces to matching
the interface hiro_tool addBlacklist fuzzy "fuzzyurl"
blacklist If information similar to the following is displayed, the
interface is successfully added to the interface blacklist
for prefix matching. Otherwise, contact Huawei technical
support.
Add blacklist url successful!
NOTE
fuzzyurl indicates the prefix of the interface path to be added,
for example, /rest/adminhome/website/v1/dashboards. If
there are multiple paths, use commas (,) to separate them.
– Adding an interface to the interface blacklist for exact
matching
hiro_tool addBlacklist accurate "accurateurl"
If information similar to the following is displayed, the
interface is successfully added to the interface blacklist
for exact matching. Otherwise, contact Huawei technical
support.
NOTE
accurateurl indicates the exact interface path to be added. If
there are multiple paths, use commas (,) to separate them, for
example, /rest/adminhome/website/v1/widgets,/rest/
adminhome/website/v1/slide-setting.

iMaster NCE-Fabric
Task Operation
Deleting – Deleting an interface from the interface blacklist for

interfaces prefix matching
from the hiro_tool deleteBlacklist fuzzy "fuzzyurl"
interface If information similar to the following is displayed, the
blacklist interface is successfully deleted from the interface
blacklist for prefix matching. Otherwise, contact Huawei
technical support.
Delete blacklist url successful!
NOTE
fuzzyurl indicates the prefix of the interface path to be added,
for example, /rest/adminhome/website/v1/dashboards. If
there are multiple paths, use commas (,) to separate them.
– Deleting an interface from the interface blacklist for
exact matching
hiro_tool deleteBlacklist accurate "accurateurl"
If information similar to the following is displayed, the
interface is successfully deleted from the interface
blacklist for exact matching. Otherwise, contact Huawei
technical support.
NOTE
accurateurl indicates the exact interface path to be added. If
there are multiple paths, use commas (,) to separate them, for
example, /rest/adminhome/website/v1/widgets,/rest/
adminhome/website/v1/slide-setting.
Step 3 Run the following command to switch to the ossadm user:
su - ossadm
Password: password for the ossadm user
Step 4 Run the following command to import environment variables:
source /opt/oss/manager/bin/engr_profile.sh
Step 5 Run the following command to restart HIROERService:
ipmc_adm -cmd restartapp -tenant product name -app HIROERService
If information similar to the following is displayed, HIROERService is restarted

successfully. Otherwise, contact Huawei technical support.
Stopping process hiroer-0-0 ... success
Starting process hiroer-0-0 ... success
Step 6 When the service plane is deployed in cluster mode, repeat Step 2on the node
where the standby hiroer process instance resides to configure the interface
blacklist.
----End

iMaster NCE-Fabric
1.6.9 Configuring the HIROAPIGService Interface Blacklist

In the O&M plane, when a third-party system (for example, the upper-layer NMS)
accesses CloudSOP by calling OpenAPIs, you can add the risky OpenAPIs to the
HIROAPIGService interface blacklists to prevent malicious interface attacks. The
service functions of the interfaces added to the interface blacklist are unavailable.
You need to delete them from the HIROAPIGService interface blacklist to restore
these interfaces and their service functions.
Prerequisites
You have obtained the passwords for the sopuser, ossuser, and ossadm users of
the nodes where the active and standby hiroapig process instances reside.
Procedure
Step 1 Use PuTTY to log in to the node where the active hiroapig process instance of
MinApiMgr resides, as the sopuser user. For details about how to check the active/
standby status and IP address of a process instance.
NOTE
If the O&M plane is deployed in single-server mode, log in to the node where MinApiMgr
resides. For details about how to obtain the IP address of the node where MinApiMgr
resides.
Step 2 Run the following command to switch to the ossuser user:

su - ossuser
Password: password for the ossuser user
Step 3 Run the following command to go to the target directory:

cd /opt/oss/SOP/apps/HIROAPIGService/init
Step 4 Run the following command to execute environment variables:
source hiro_tool.sh
Step 5 Run the following commands to configure the interface blacklist:

iMaster NCE-Fabric
Table 1-17 Configuring the interface blacklist
Task Operation
Adding ● Adding an interface to the interface blacklist for prefix matching

interface hiro_tool addBlacklist fuzzy "fuzzyurl"
s to the If information similar to the following is displayed, the interface is
interface successfully added to the interface blacklist for prefix matching.
blacklist Otherwise, contact Huawei technical support.
NOTE
fuzzyurl indicates the prefix of the interface path to be added, for
example, /rest/adminhome/website/v1/dashboards. If there are multiple
paths, use commas (,) to separate them.
● Adding an interface to the blacklist of exact interfaces
hiro_tool addBlacklist accurate "accurateurl"
If information similar to the following is displayed, the interface is
successfully added to the blacklist of exact interfaces. Otherwise,
contact Huawei technical support.
NOTE
accurateurl indicates the exact interface path to be added. If there are
multiple paths, use commas (,) to separate them, for example, /rest/
adminhome/website/v1/widgets,/rest/adminhome/website/v1/slide-
setting.
Deleting ● Deleting an interface from the interface blacklist for prefix

interface matching
s from hiro_tool deleteBlacklist fuzzy "fuzzyurl"
the If information similar to the following is displayed, the interface is
interface successfully deleted from the interface blacklist for prefix
blacklist matching. Otherwise, contact Huawei technical support.
NOTE
fuzzyurl indicates the prefix of the interface path to be added, for
example, /rest/adminhome/website/v1/dashboards. If there are multiple
paths, use commas (,) to separate them.
● Deleting an interface from the blacklist of exact interfaces
hiro_tool deleteBlacklist accurate "accurateurl"
If information similar to the following is displayed, the interface is
successfully deleted from the blacklist of exact interfaces.
Otherwise, contact Huawei technical support.
NOTE
accurateurl indicates the exact interface path to be added. If there are
multiple paths, use commas (,) to separate them, for example, /rest/
adminhome/website/v1/widgets,/rest/adminhome/website/v1/slide-
setting.
Step 6 Run the following command to switch to the ossadm user:
su - ossadm
Password: password for the ossadm user

iMaster NCE-Fabric
Step 7 Run the following command to execute environment variables:

source /opt/oss/manager/bin/engr_profile.sh
Step 8 Run the following command to restart HIROAPIGService:
ipmc_adm -cmd restartapp -tenant product name -app HIROAPIGService
If information similar to the following is displayed, HIROAPIGService is restarted
successfully. Otherwise, contact Huawei technical support.
Stopping process hiroapig-1-0 ... success
Starting process hiroapig-1-0 ... success
Step 9 If the O&M plane is deployed in cluster mode, repeat Step 1 to #EN-
US_TOPIC_0000001192232474/en-us_topic_0000001176302258_en-
us_topic_0000001171744844_en-us_topic_0000001171880654_li1275783513176
on the node where the standby hiroapig process instance resides to configure the
interface blacklist.
----End
1.7 Authentication Interface

This interface is used to obtain a Token. The Token is effective in a certain time
period, and needs to be acquired again from the authentication interface when
the validity period expires.
NOTE
Being the first interface invoked by a third-party application system, the authentication
interface returns the Token ID. Before invoking any other interface, the third-party
application system must set X-ACCESS-TOKEN in the HTTP header to a Token ID.
Otherwise, the system will display "403: Authentication failed." when another interface is
invoked.
Interface Description
Interface access path:
https://{ip}:{port}/controller/v2/tokens
HTTP request mode:

POST
Request body parameters

iMaster NCE-Fabric
Parameter Type Mandatory Description

or Not
userName string Yes Name of a northbound

interface user.
The northbound interface
user is added to iMaster
NCE-Fabric using the
account admin.
password string Yes Password of the

northbound interface
user.
The password of the
northbound interface user
is added to the iMaster
NCE-Fabric using the
account admin.
Response body parameters

or Not
errcode string Yes Returned message code.

The value 0 indicates
success. For others, see
description of errmsg.
errmsg string Yes Information contained in

the returned message
code.
data data Yes Returned Token

information.
Format of the data field

or Not
expiredDate date Yes Token expired time.

Format: 2016-01-13
19:52:40
token_id string Yes Token ID.

iMaster NCE-Fabric
Sample
Message Type Reference
JSON request POST /controller/v2/tokens

{
"userName": "esdk@huawei.com",
"password": "Test@123"
}
Status code STATUS CODE 200
JSON response {
"errmsg": "get token successfully.",
"errcode": "0",
"data": {
"expiredDate": "2016-12-22 16:14:19",
"token_id":
"67D5807D096CF5DA:CECC49BBC0394778AAC056E35D690FF88ADFB19
D949F2E41C329D372CBD99FD4"
}
}
1.8 SNMP
iMaster NCE-Fabric provides the SNMP NBI for the OSS to manage alarms.
1.8.1 Overview
The SNMP NBI is one of the NBIs provided by iMaster NCE-Fabric. The OSS can
access iMaster NCE-Fabric through the SNMP NBI to monitor and manage alarms
in networks.
The SNMP protocol consists of a set of standards for network management and is
one of the most widely used protocols in TCP/IP networks.
As one of the widely applied network management protocols in the TCP/IP
network, SNMP aims to:
● Transmit the management information between two nodes.
● Help the manager search and modify the information, and locate faults on
any node in the network.
● Help the manager diagnose faults, configure NEs, and generate reports.
The features of SNMP are as follows:
● Uses the polling mechanism and provides basic operation sets.
● Fits small, fast, and cost-effective networks.
Huawei developed the SNMP NBI for iMaster NCE-Fabric in compliance with
industry standards. With this NBI, the OSS can interconnect with iMaster NCE-
Fabric quickly and monitor and manage alarms on the network.
The Simple Network Management Protocol (SNMP) northbound interface (NBI)
supports three formats of management information bases (MIBs): MIB1, MIB2,
and MIB3. Currently, iMaster NCE-Fabric supports only MIB1.

iMaster NCE-Fabric
● Both HW-IMAPV1NORTHBOUND-TRAP-MIB.mib and HW-

IMAPV2NORTHBOUND-TRAP-MIB.mib refer to the MIB1, which is used to
manage transport, access, and datacom devices, or cross-domain devices. V1
and V2 indicate the Structure of Management Information (SMI) versions of
HW-IMAPV1NORTHBOUND-TRAP-MIB.mib and HW-
IMAPV2NORTHBOUND-TRAP-MIB.mib respectively. The OSS selects a
version based on its supported SMI version. SMI versions differ in syntax. For
details, see RFC 1155 and RFC 1902.
● Both IMAP_NORTHBOUND_MIB-V1.mib and IMAP_NORTHBOUND_MIB-
V2.mib refer to the MIB2. V1 and V2 indicate the SMI versions of
IMAP_NORTHBOUND_MIB-V1.mib and IMAP_NORTHBOUND_MIB-V2.mib
respectively. The OSS selects a version based on its supported SMI version.
SMI versions differ in syntax. For details, see RFC 1155 and RFC 1902.
● T2000-NETMANAGEMENT-MIB.mib refers to the MIB3 and complies with
SMIv2.
1.8.2 MIB1
MIB1 has two versions: HW-IMAPV1NORTHBOUND-TRAP-MIB and HW-
IMAPV2NORTHBOUND-TRAP-MIB. The OSS selects a version based on its
supported SMI version.
This document uses HW-IMAPV1NORTHBOUND-TRAP-MIB as an example.
SMI Version MIB
SMI-V1 HW-IMAPV1NORTHBOUND-TRAP-MIB.mib
SMI-V2 HW-IMAPV2NORTHBOUND-TRAP-MIB.mib
1.8.2.1 MIB1
The MIB1 is used to manage transport, access, and datacom devices or manage
multi-domain devices. When the MIB1 is loaded, the SNMP NBI supports
automatic alarm reporting, synchronization (querying active alarms), clearance,
acknowledgement/unacknowledgement, and alarm acknowledgement and
clearance status reporting.
NCE
On the NCE side, the primary functions are:
● Reporting alarms
● Reporting heartbeats
NOTE
To enable automatic alarm reporting, set OSS parameters on NCE when configuring the
SNMP NBI. Alarm information will be received at the preset port of the OSS server.
After receiving alarms from devices or NCE, the SNMP NBI reports these alarms to
the OSS by means of standard SNMP trap messages.

iMaster NCE-Fabric
The SNMP NBI sends heartbeat traps to the OSS periodically. Based on the
heartbeats, the OSS determines whether the connection with the SNMP NBI is
proper.
For details about traps, see 1.8.2.4 MIB1 Trap.
Functio Description
n
Subscrib Subscribes alarms by alarm severity and category. You can set the
ing severity and category when deploying the SNMP NBI.
alarms Sets the alarm field or variable binding (VB).
Reportin Reports alarms from NEs or NCE.

g
alarms
Reportin Reports heartbeats and sets the heartbeat period.

g
heartbe
ats
Reportin Reports the alarm acknowledgement status.

g alarm
acknowl
edgeme
nt
status
Reportin Reports the alarm clearance status.

g alarm
clearanc
e status
OSS
On the OSS side, the primary functions are:
● Synchronizing alarms (querying active alarms)
● Changing filter criteria in real time
● Acknowledging/Unacknowledging alarms
● Clearing alarms
NOTE
Ensure that the OSS is connected to the SNMP NBI properly before performing operations.

iMaster NCE-Fabric
Functio Description
n
Synchro Queries active alarms (uncleared alarms) on NCE in the Set

nizing operation. The OSS uses the Set operation to query these alarms on
alarms NCE.
(queryin To query active alarms on NCE, the OSS issues the query begin
g active command in the Set operation. After receiving the command, the
alarms) SNMP agent queries active alarms from NCE and reports the result to
the OSS. If there are too many alarms and the query needs to be
stopped, the OSS issues the query end command in the Set
operation. After receiving the command, the SNMP agent stops
querying alarms and does not report the result to the OSS.
For details about alarm synchronization, see 1.8.8.1.3 Synchronizing
Alarms.
For details about traps, see MIB1 Trap.
Queryin Reports alarms by alarm severity and category. The filter criteria are
g specified during alarm subscription.
alarms You can change filter criteria in real time when loading the MIB1.
by
criteria
Changin Changes filter criteria using the Set operation when the SNMP NBI is
g filter running. The filter criteria are specified during alarm subscription.
criteria The change will take effect without restarting the SNMP NBI.
in real
time
Acknowl Acknowledges or unacknowledges current alarms on NCE based on

edging/ alarm SNs.
Unackn
owledgi
ng
alarms
Clearing Clears alarms on NCE based on alarm SNs.

alarms
1.8.2.2 MIB Description

The complete HW-IMAPV1NORTHBOUND-TRAP-MIB MIB node information is as
follows:
iso(1).org(3).dod(6).internet(1).private(4).enterprises(1).huawei(2011).products(2)
.hwNetManagement(15).hwNmAgent(1)
The MIB tree is shown as follows:
--- huawei(2011)
|--- products(2)
|--- hwNetManagement(15)
|--- hwNmAgent(1)

iMaster NCE-Fabric
|---- hwNmFault(3)
hwNmFault defines the SNMP NBI.
For details about the function interfaces of MIB1, see 1.8.8.1 MIB1 Subinterfaces.
1.8.2.3 Alarm Fields Reported by MIB1

MIB1 supports 21 alarm fields. You can customize the alarm fields as required.
When the MIB frame is set to MIB1, the SNMP NBI reports the following alarm
fields. You can customize them as required.
T2000Support=0
The following table describes the fields reported by the SNMP NBI if
T2000Support is 0.
Table 1-18 T2000Support=0
Name Name in Description Value Parsing

the MIB Supporte
d
NE hwNmNort Name of the NE where an Octet No

Name hboundNEN alarm is generated. string
ame ● For alarms generated on an
NE, the NE name is
reported.
● For alarms generated due to
NE disconnection, the NE
name is reported. For
example, if alarms are
generated due to NE login
failures or NE disconnection,
the NE name is reported.
● For other NMS alarms, the
NMS name is reported. By
default, OSS is reported. If
the NMS name is changed,
the name of the changed
NMS is reported.
NE hwNmNort Type of the NE on which Octet No

Type hboundNET alarms are generated. For NMS string
ype alarms, the NMS name is
reported.
Object hwNmNort Location information. For Octet No

instanc hboundObj details, see Table 1-20. string
e ectInstance

iMaster NCE-Fabric

the MIB Supporte
d
Event hwNmNort Alarm type. For non-X.733- Octet Yes. See

Type hboundEve compliant alarms, options are string the
ntType as follows: enumerat
● Environment ed value.
● Equipment
● Communication
● Service
● Process
● Security
For X.733-compliant alarms,
options are as follows:
● EnvironmentalAlarm
● EquipmentAlarm
● CommunicationsAlarm
● QualityofServiceAlarm
● ProcessingErrorAlarm
● SecurityAlarm

iMaster NCE-Fabric

the MIB Supporte
d
Alarm hwNmNort Time when an alarm is Octet Yes. See

Occurre hboundEve generated, cleared, string the time
nce ntTime acknowledged, format.
Time unacknowledged, or changed.
● If an alarm is generated, this
parameter indicates the time
when the alarm is
generated.
● If an alarm is cleared, this
when the alarm is cleared.
● If an alarm is acknowledged,
this parameter indicates the
time when the alarm is
acknowledged.
● If an alarm is
unacknowledged, this
when the alarm is
unacknowledged.
● If an alarm is changed, this
when the alarm is changed.
The options can be in any of
the following formats:
● UTC time. The format is
YYYY/MM/DD - hh:mm:ssZ,
for example, 2009/12/23 -
11:30:30Z.
● Local time without the time
zone. The format is
YYYY/MM/DD - hh:mm:ss,
for example, 2009/12/23 -
19:30:30.
● Local time with the time
zone. The format is
YYYY/MM/DD - hh:mm:ss,
hh:mmTZ[DST], where TZ
stands for the time zone
information and DST stands
for the DST offset. The
following lists examples:
– 2009/12/23 - 19:30:30
+ 08:00[0] (The date is
not in DST.)

iMaster NCE-Fabric

the MIB Supporte
d
– 2009/12/23 - 19:30:30
+ 08:00[+01:00] (The DST
offset is 1 hour.)
● Local time. The format is
YYYY-MM-dd hh:mm:ss +
hh:mm TZ + hh:mm DST,
where TZ stands for the time
zone information and DST
stands for the DST offset.
The following lists examples:
– 2009-12-23 19:30:30
+ 08:00 TZ (The date is
not in DST.)
– 2009-12-23 19:30:30
+ 08:00 TZ + 01:00 DST
(The DST offset is 1
hour.)
YYYY-MM-dd hh:mm:ss, for
example, 2009-12-23
11:30:30.
Alarm hwNmNort Possible causes for an alarm. Octet No

Cause hboundProb Format: ID: string
ableCause [ReasonId],DeviceType:
[DeviceTypeId],Alarm Cause
Alarm hwNmNort Alarm severity. Octet Yes. See

Severity hboundSeve ● Critical string the
rity enumerat
● Major ed value.
● Minor
● Warning
● Cleared: This option is
supported for X.733-
compliant alarms.
Alarm hwNmNort ID, device type, and details of Octet No

Details hboundEve an alarm. string
ntDetail Format: ID:
[AlarmId],DeviceType:
[DeviceTypeId],Alarm Details
Alarm hwNmNort Specific location of the NE Octet No

Locatio hboundAddi where an alarm is generated. string
n tionalInfo

iMaster NCE-Fabric

the MIB Supporte
d
Type hwNmNort Alarm type. Options are as Octet Yes. See

Flag hboundFaul follows: string the
tFlag ● Event: indicates that an enumerat
event is generated. ed value.
● Fault: indicates that an
alarm is generated.
● Recovery: indicates that the
alarm is cleared.
● Acknowledge: indicates that
the alarm is acknowledged.
● Unacknowledge: indicates
that the alarm is
unacknowledged.
● Change: indicates that the
alarm is changed.
Alarm hwNmNort Alarm type based on functions, Octet Yes. See

Functio hboundFaul which is the same as string the
n tFunction hwNmNorthboundEventType. enumerat
Categor ed value.
y
Manag hwNmNort IP address of the NE. IP No

ed hboundDevi address
Equipm ceIP
ent
Address
Alarm hwNmNort Sequence number of an alarm. Integer No

Serial hboundSeri
Numbe alNo
r
Alarm hwNmNort Advice for clearing alarms. Octet No

Clearan hboundProb Format: ID: string
ce ableRepair [ReasonId],DeviceType:
Advice [DeviceTypeId],Alarm Clearance
Advice
Resourc hwNmNort ID of the resource where an Octet No

e ID hboundRes alarm is generated. string
ourceIDs
Event hwNmNort Name of an alarm. Octet No

Name hboundEve Format: ID: string
ntName [AlarmId],DeviceType:
[DeviceTypeId],Event Name

iMaster NCE-Fabric

the MIB Supporte
d
Alarm hwNmNort Alarm cause ID. Integer No

Cause hboundReas
ID onID
Alarm hwNmNort Alarm ID. Integer No

ID hboundFaul
tID
Manag hwNmNort Managed device type. Octet No

ed hboundDevi string
Equipm ceType
ent
Type
Trail hwNmNort Name of the trail affected by Octet No

Name hboundTrail an alarm. If alarm A affects a string
Name trail, a new change alarm B will
be generated. The sequence
number of alarm B is the same
as that of alarm A. The severity
of alarm B is Change. Trail
Name in alarm B indicates the
affected trail. However, for
alarm A, Trail Name is blank.
Root hwNmNort Whether the alarm is the root Integer Yes. See
Alarm hboundRoo alarm or not. Options are as the
tAlarm follows: enumerat
● 0: Non-root alarm ed value.
● 1: Root alarm
Group hwNmNort ID of the alarm group. Integer No

ID hboundGro
upID

iMaster NCE-Fabric

the MIB Supporte
d
Enginee hwNmNort Whether this alarm is Integer Yes. See

ring hboundMai generated by the NE in the the
Alarm ntainStatus engineering maintenance state. enumerat
Status Maintenance engineers can ed value.
focus on engineering alarms
selectively.
● 0: Non-engineering alarms
● 1: Engineering alarms
NOTE
NEs during engineering
commissioning or service cutover
generate a large number of
alarms, and you can set the NEs to
the engineering maintenance
state. Therefore, the alarms
generated by this kind of NE are
engineering alarms.
Root hwNmNort Sequence number of the root Octet No

Alarm hboundRoo alarm. string
Serial tAlarmSeria
Numbe lNo
r
Alarm hwNmNort Alarm acknowledgement Integer Yes. See

Acknow hboundConf status. the
ledgem irmStatus ● 1: acknowledged enumerat
ent ed value.
Status ● 2: unacknowledged
Alarm hwNmNort Alarm clearance status. Integer Yes. See

Clearan hboundRest ● 1: cleared the
ce oreStatus enumerat
Status ● 2: uncleared ed value.
T2000Support=1
The following table describes the fields reported by the SNMP NBI if
T2000Support is 1.

iMaster NCE-Fabric

Name Name in the MIB Description
Object hwNmNorthboun Format: source=[NE Name] location=[location

instance dObjectInstance information]
source indicates the alarm source, and
location indicates the location information.
Example: source=CE1-test-1 location=User
name=VTY user IP=10.78.224.206 User
channel=VTY4 Sequence number:649018
Alarm hwNmNorthboun The alarm cause ID and NE ID are not

Cause dProbableCause reported, and only the alarm cause is
contained.
Example: The user logs out or fails to log in.
Alarm hwNmNorthboun The alarm ID and NE ID are not reported, and

Details dEventDetail only the alarm details are contained.
Example: NE NE(9-8886) not login
Alarm hwNmNorthboun The alarm cause ID and NE ID are not

Clearance dProbableRepair reported, and only the alarm clearance advice
Advice is contained.
Example: None
Event hwNmNorthboun The alarm ID and NE ID are not reported, and

Name dEventName only the event name is contained.
Example: NE_NOT_LOGIN
Location Information Format
Table 1-20 Location information format

Location Information Format Description
Format: [Location Information] Alarm information of IP NEs.

[Additional Information]
1.8.2.4 MIB1 Trap

The SNMP NBI supports the following traps when MIB1 is loaded.

iMaster NCE-Fabric
1.8.2.4.1 Alarm Notification Trap
Function
When alarms are generated on NEs or iMaster NCE-Fabric, iMaster NCE-Fabric
actively sends this type of traps to inform third-party systems of real-time alarms
automatically using the SNMP NBI.
Trigger Condition
When alarms are generated on NEs or iMaster NCE-Fabric, alarm notification
traps are triggered.
Definition
Name OID Type Description
hwNmNorthboun 1.3.6.1.4.1.2011.2. Trap/Inform Real-time alarms

dEventNotify 15.1.7.1.0.1 are reported.
VB List
NOTE
The definitions of alarm fields in alarm synchronization result traps are the same as those
in alarm notification traps. The only difference is that the former is iMaster NCE-Fabric's
response to the query of valid alarms, whereas the latter is actively reported by iMaster
NCE-Fabric.
Name in the OID Type Description

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet NE name.

ndNEName .15.1.7.1.1 string
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet NE type.

ndNEType .15.1.7.1.2 string
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm location. The options

ndObjectInstanc .15.1.7.1.3 string are as follows:
e ● Rack
● Frame
● Slot
● Subslot
● Port

iMaster NCE-Fabric

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Type of an event. The options

ndEventType .15.1.7.1.4 string are as follows:
● Communication
● Environment
● Equipment
● Service
● Process
● Security
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Time when the alarm was

ndEventTime .15.1.7.1.5 string generated. The format is as
follows:
● Local time without time
zone in the format of
yyyy/MM/dd - hh:mm:ss
● UTC time in the format of
yyyy/MM/dd - hh:mm:ssZ
● Local time with time zone
in the format of
yyyy/MM/dd -
hh:mm:ssTZ[DST]
● Local time in the format
of yyyy-MM-dd hh:mm:ss
+ hh:mm TZ + hh:mm DST
YYYY-MM-dd hh:mm:ss
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Possible causes of an alarm.

ndProbableCaus .15.1.7.1.6 string
e
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm severity. The options

ndSeverity .15.1.7.1.7 string are as follows:
● Critical
● Major
● Minor
● Warning
● Indeterminate
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm ID and detailed

ndEventDetail .15.1.7.1.8 string information.
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Additional information of an

ndAdditionalInfo .15.1.7.1.9 string NE.

iMaster NCE-Fabric

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Flag bit for an alarm. The

ndFaultFlag .15.1.7.1.10 string options are as follows:
● Event: indicates that an
event is generated.
alarm is generated.
● Recovery: indicates that
the alarm is cleared.
● Acknowledge: indicates
that the alarm is
acknowledged.
that the alarm is
unacknowledged.
alarm is changed.
● UNKNOWN_EVENT_TYPE:
unknown event type.
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm type. The options are

ndFaultFunction .15.1.7.1.11 string as follows:
● Environment
● Equipment
● Communication
● Service
● Security
● Process
hwNmNorthbou 1.3.6.1.4.1.2011.2 IpAddres IP address of an NE.

ndDeviceIP .15.1.7.1.12 s
hwNmNorthbou 1.3.6.1.4.1.2011.2 INTEGER SN of an alarm.

ndSerialNo .15.1.7.1.13
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm troubleshooting

ndProbableRepai .15.1.7.1.14 string suggestions.
r
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet ID of a resource.

ndResourceIDs .15.1.7.1.15 string
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm UUID of the physical

ndsAdditionalVB .15.1.7.1.16 string resources (NEs, boards, and
1 ports) in the IP domain.

iMaster NCE-Fabric

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Reserved field.

ndsAdditionalVB .15.1.7.1.17 string
2

3

4

5

6

7

8
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Name of an event.

ndEventName .15.1.7.1.24 string
hwNmNorthbou 1.3.6.1.4.1.2011.2 INTEGER Alarm ID.

ndReasonID .15.1.7.1.25
hwNmNorthbou 1.3.6.1.4.1.2011.2 INTEGER Fault ID of an alarm.

ndFaultID .15.1.7.1.26
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Device type ID of an alarm.

ndDeviceType .15.1.7.1.27 string
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Name of the trail affected by

ndTrailName .15.1.7.1.28 string an alarm.
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Whether the alarm is the

ndRootAlarm .15.1.7.1.29 root alarm.
● 0: non-root alarm
● 1: root alarm
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Alarm group ID.

ndGroupID .15.1.7.1.30

iMaster NCE-Fabric

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Engineering alarm status.

ndMaintainStatu .15.1.7.1.31
s
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet SN of the root alarm.

ndRootAlarmSeri .15.1.7.1.32 string
alNo
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Alarm acknowledgement

ndConfirmStatus .15.1.7.1.33 status.
● 1: acknowledged
● 2: unacknowledged
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Alarm clearance status.

ndRestoreStatus .15.1.7.1.34 ● 1: cleared
● 2: uncleared
Example
The following is an example of the real-time alarm trap complying with SNMPv3:
hwNmNorthboundEventNotify
Message reception date: 2020/3/22
Message reception time: 0:03:07.120
Time stamp: 0 days 01h:41m:36s.96th (609696)
Message type: Notification (Trap)
Protocol version: SNMPv3
Transport: IP/UDP
Agent
Address: 10.185.199.167
Port: 6666
Manager
Address: 192.168.57.114
Port: 8899
Security parameters
Security level: Authentication and Privacy
Security name: admin
Security engine ID: 0x80 0x00 0x13 0x70 0x01 0xC0 0xA8 0x80 0x9E
Context engine ID: 0x80 0x00 0x13 0x70 0x01 0xC0 0xA8 0x80 0x9E
Authentication protocol: HMAC SHA
Privacy protocol: CFB AES 128
Bindings (25)
Binding #1: sysUpTime.0 *** (TimeTicks) 0 days 01h:41m:36s.96th (609696)
Binding #2: snmpModules.1.1.4.1.0 *** (object identifier) hwNmNorthboundEventNotify
Binding #3: hwNmNorthboundNEName.0 *** (OCTET STRING) OSS
Binding #4: hwNmNorthboundNEType.0 *** (OCTET STRING) OSS
Binding #5: hwNmNorthboundObjectInstance.0 *** (OCTET STRING) source=OSS location=Product
Name=iMaster NCE-Fabric
Binding #6: hwNmNorthboundEventType.0 *** (OCTET STRING) Process
Binding #7: hwNmNorthboundEventTime.0 *** (OCTET STRING) 2020/03/21 - 15:00:59Z
Binding #8: hwNmNorthboundProbableCause.0 *** (OCTET STRING) (zero-length)
Binding #9: hwNmNorthboundSeverity.0 *** (OCTET STRING) Warning
Binding #10: hwNmNorthboundEventDetail.0 *** (OCTET STRING)
Binding #11: hwNmNorthboundAdditionalInfo.0 *** (OCTET STRING) Weak algorithm: CBC
algorithm(Port:22) ;Weak protocol: NA ;Plaintext transmission port: NA
Binding #12: hwNmNorthboundFaultFlag.0 *** (OCTET STRING) Acknowledge
Binding #13: hwNmNorthboundFaultFunction.0 *** (OCTET STRING) Process

iMaster NCE-Fabric
Binding #14: hwNmNorthboundDeviceIP.0 *** (IpAddress) 192.168.128.158

Binding #15: hwNmNorthboundSerialNo.0 *** (Integer32) 77040
Binding #16: hwNmNorthboundProbableRepair.0 *** (OCTET STRING) (zero-length)
Binding #17: hwNmNorthboundResourceIDs.0 *** (OCTET STRING) -1.-1.-1.-1.-1.-1.-1.-1
Binding #18: hwNmNorthboundEventName.0 *** (OCTET STRING) Weak Algorithms or Protocols Exist
Binding #19: hwNmNorthboundReasonID.0 *** (Integer32) 0
Binding #20: hwNmNorthboundFaultID.0 *** (Integer32) 317
Binding #21: hwNmNorthboundDeviceType.0 *** (OCTET STRING) 0
Binding #22: hwNmNorthboundTrailName.0 *** (OCTET STRING) (zero-length)
Binding #23: hwNmNorthboundRootAlarm.0 *** (Integer32) 0
Binding #24: hwNmNorthboundGroupID.0 *** (Integer32) 100000
Binding #25: hwNmNorthboundMaintainStatus.0 *** (Integer32) 0
1.8.2.4.2 Alarm Synchronization Start Trap

The alarm synchronization start trap
(hwNmNorthboundEventSynchronizationCommandStart) informs the OSS that
alarm synchronization has started.
Function
After the OSS sends alarm query requests, the SNMP NBI returns this type of trap
to the OSS to indicate that alarm synchronization has started.
Trigger Condition
The OSS triggers the alarm synchronization. For details, see 1.8.8.1.3
Synchronizing Alarms.
The OSS sets hwNmNorthboundEventSynchronizationCommandStart in the
following format:
NMS IP address:Port:Start time:End time
NOTE
● NMS IP address:Port refers to the IP address and port of the OSS.

● The format for the start time and end time is YYYYMMDDhhmmss.
Definition
Name ENTERPRISE Type Description
hwNmNorthboun hwNmNorthboun Trap/Inform Alarm

dEventSynchroni- dEventSynchroni- synchronization
zationStartNotify zationStart start trap.
VB List
None

iMaster NCE-Fabric
1.8.2.4.3 Alarm Synchronization Result Trap
Function
After the third-party system sends an alarm synchronization request, iMaster NCE-
Fabric sends the alarm synchronization trap through the SNMP NBI to return
alarms meeting the query conditions to the third-party system.
Trigger Condition
The third-party system triggers alarm synchronization.
The third-party system sets
hwNmNorthboundEventSynchronizationCommandStart in the MIB to start
alarm synchronization. Format: NMS IP address:port number:start time:end time
NOTE
● NMS IP address:port number indicates the IP address and port number of the third-party
system.
● The format for start and end time is YYYYMMDDhhmmss.
Definition
hwNmNorthboun 1.3.6.1.4.1.2011.2. Trap/Inform Alarm

dEventSynchroni- 15.1.7.7.2.0.10 synchronization
zationQueryResult result.
Notify
VB List
NOTE
The definitions of alarm fields in alarm synchronization result traps are the same as those
in alarm notification traps. The only difference is that the former is iMaster NCE-Fabric's
response to the query of valid alarms, whereas the latter is actively reported by iMaster
NCE-Fabric.

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet NE name.

ndNEName .15.1.7.1.1 string
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet NE type.

ndNEType .15.1.7.1.2 string

iMaster NCE-Fabric

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm location. The options

ndObjectInstanc .15.1.7.1.3 string are as follows:
e ● Rack
● Frame
● Slot
● Subslot
● Port
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Type of an event. The options

ndEventType .15.1.7.1.4 string are as follows:
● Communication
● Environment
● Equipment
● Service
● Process
● Security
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Time when the alarm was

ndEventTime .15.1.7.1.5 string generated. The format is as
follows:
● Local time without time
zone in the format of
yyyy/MM/dd - hh:mm:ss
yyyy/MM/dd - hh:mm:ssZ
● Local time with time zone
in the format of
yyyy/MM/dd - HH:mm:ss
TZ[DST]
● Local time in the format
of yyyy-MM-dd hh:mm:ss
+ hh:mm TZ + hh:mm DST
YYYY-MM-dd hh:mm:ss
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Possible causes of an alarm.

ndProbableCaus .15.1.7.1.6 string
e

iMaster NCE-Fabric

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm severity. The options

ndSeverity .15.1.7.1.7 string are as follows:
● Critical
● Major
● Minor
● Warning
● Indeterminate
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm ID and detailed

ndEventDetail .15.1.7.1.8 string information.
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Additional information of an

ndAdditionalInfo .15.1.7.1.9 string NE.
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Flag bit for an alarm. The

ndFaultFlag .15.1.7.1.10 string options are as follows:
● Event: indicates that an
event is generated.
alarm is generated.
that the alarm is
acknowledged.
that the alarm is
unacknowledged.
alarm is changed.
● UNKNOWN_EVENT_TYPE:
unknown event type.
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm type. The options are

ndFaultFunction .15.1.7.1.11 string as follows:
● Communication
● Environment
● Equipment
● Service
● Process
● Security
hwNmNorthbou 1.3.6.1.4.1.2011.2 IpAddres IP address of an NE.

ndDeviceIP .15.1.7.1.12 s

iMaster NCE-Fabric

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 INTEGER SN of an alarm.

ndSerialNo .15.1.7.1.13
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm troubleshooting

ndProbableRepai .15.1.7.1.14 string suggestions.
r
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet ID of a resource.

ndResourceIDs .15.1.7.1.15 string
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Alarm UUID of the physical

ndsAdditionalVB .15.1.7.1.16 string resources (NEs, boards, and
1 ports) in the IP domain.

2

3

4

5

6

7

8
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Name of an event.

ndEventName .15.1.7.1.24 string
hwNmNorthbou 1.3.6.1.4.1.2011.2 INTEGER Alarm ID.

ndReasonID .15.1.7.1.25
hwNmNorthbou 1.3.6.1.4.1.2011.2 INTEGER Fault ID of an alarm.

ndFaultID .15.1.7.1.26
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Device type ID of an alarm.

ndDeviceType .15.1.7.1.27 string

iMaster NCE-Fabric

MIB
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet Name of the trail affected by

ndTrailName .15.1.7.1.28 string an alarm.
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Whether the alarm is the

ndRootAlarm .15.1.7.1.29 root alarm.
● 0: non-root alarm
● 1: root alarm
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Alarm group ID.

ndGroupID .15.1.7.1.30
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Engineering alarm status.

ndMaintainStatu .15.1.7.1.31
s
hwNmNorthbou 1.3.6.1.4.1.2011.2 Octet SN of the root alarm.

ndRootAlarmSeri .15.1.7.1.32 string
alNo
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Alarm acknowledgement

ndConfirmStatus .15.1.7.1.33 status.
● 1: acknowledged
hwNmNorthbou 1.3.6.1.4.1.2011.2 Integer Alarm clearance status.

ndRestoreStatus .15.1.7.1.34 ● 1: cleared
● 2: uncleared
Example
The following is an example of the alarm synchronization trap complying with
SNMPv3:
hwNmNorthboundEventSynchronizationQueryResultNotify
Transport: IP/UDP
Agent
Address: 10.185.199.167
Port: 6666
Manager
Address: 192.168.57.114
Port: 8899
Security parameters
Bindings (25)

iMaster NCE-Fabric

Binding #2: snmpModules.1.1.4.1.0 *** (object identifier)
hwNmNorthboundEventSynchronizationQueryResultNotify
Binding #3: hwNmNorthboundNEName.0 *** (OCTET STRING) OSS
Binding #4: hwNmNorthboundNEType.0 *** (OCTET STRING) OSS
Binding #5: hwNmNorthboundObjectInstance.0 *** (OCTET STRING) source=OSS location=neName=test,
neIP=10.10.101.1, neBackupIP=NULL, NE error port=6007, NE error code=N/A, Error message=Failed to set
up ssl connections towards the peer end, Mediation pa ...
Binding #6: hwNmNorthboundEventType.0 *** (OCTET STRING) Process
Binding #7: hwNmNorthboundEventTime.0 *** (OCTET STRING) 2019/11/01 - 09:14:08Z
Binding #8: hwNmNorthboundProbableCause.0 *** (OCTET STRING) (zero-length)
Binding #9: hwNmNorthboundSeverity.0 *** (OCTET STRING) Critical
Binding #10: hwNmNorthboundEventDetail.0 *** (OCTET STRING)
Binding #11: hwNmNorthboundAdditionalInfo.0 *** (OCTET STRING) Changed Error message=Failed to
set up ssl connections towards the peer end
Binding #12: hwNmNorthboundFaultFlag.0 *** (OCTET STRING) Fault
Binding #13: hwNmNorthboundFaultFunction.0 *** (OCTET STRING) Process
Binding #14: hwNmNorthboundDeviceIP.0 *** (IpAddress) 192.168.128.158
Binding #15: hwNmNorthboundSerialNo.0 *** (Integer32) 10008
Binding #16: hwNmNorthboundProbableRepair.0 *** (OCTET STRING) (zero-length)
Binding #17: hwNmNorthboundResourceIDs.0 *** (OCTET STRING) 256.-1.-1.-1.-1.-1.-1.-1
Binding #18: hwNmNorthboundEventName.0 *** (OCTET STRING) NE Is Disconnected
Binding #19: hwNmNorthboundReasonID.0 *** (Integer32) 0
Binding #20: hwNmNorthboundFaultID.0 *** (Integer32) 301
Binding #21: hwNmNorthboundDeviceType.0 *** (OCTET STRING) 0
Binding #22: hwNmNorthboundTrailName.0 *** (OCTET STRING) (zero-length)
Binding #23: hwNmNorthboundRootAlarm.0 *** (Integer32) 0
Binding #24: hwNmNorthboundGroupID.0 *** (Integer32) 100000
Binding #25: hwNmNorthboundMaintainStatus.0 *** (Integer32) 0
1.8.2.4.4 Alarm Synchronization End Trap
Function
iMaster NCE-Fabric sends the alarm synchronization end trap to inform the third-
party system of the end of alarm synchronization. After the third-party system
receives the trap, the alarm query is complete.
Trigger Condition
Alarm synchronization end traps are triggered when:
● All alarms meeting the query conditions have been sent in traps to the third-
party system from iMaster NCE-Fabric.
● The third-party stops the synchronization.
The third-party system triggers the termination of synchronization.
The third-party system sets

hwNmNorthboundEventSynchronizationCommandStop in the MIB to stop
alarm synchronization. The SNMP NBI stops alarm synchronization with the third-
party system of the corresponding IP address and port number. The format is
NMS IP address:port number
NOTE
NMS IP address:port number indicates the IP address and port number of the third-party
system.

iMaster NCE-Fabric
Definition
hwNmNorthboun 1.3.6.1.4.1.2011.2. Trap/Inform Alarm

dEventSynchroni- 15.1.7.7.3.0.11 synchronization
zationEndNotify end trap.
VB List
VB OID Data Description
Type
hwNmNorthbou 1.3.6.1.4.1.2011.2 INTEGER Alarm synchronization result.

ndEventSynchron .15.1.7.7.3.1 The options are as follows:
izationEndStatus 1: normalEnd(1), which
indicates that the
synchronization was
complete.
2: stopped(2), which indicates
that the OSS stopped the
synchronization.
3: error(3), which indicates
that exceptions occurred
during the synchronization.
hwNmNorthbou 1.3.6.1.4.1.2011.2 OCTET Details about the

ndEventSynchron .15.1.7.7.3.2 STRING synchronization result.
izationEndStatus
Detail
Example
The following is an example of the alarm synchronization end trap complying with
SNMPv3:
hwNmNorthboundEventSynchronizationEndNotify
Transport: IP/UDP
Agent
Address: 10.185.199.167
Port: 6666
Manager
Address: 192.168.57.114
Port: 8899
Security parameters

iMaster NCE-Fabric

Bindings (4)
Binding #2: snmpModules.1.1.4.1.0 *** (object identifier)
hwNmNorthboundEventSynchronizationEndNotify
Binding #3: hwNmNorthboundEventSynchronizationEndStatus.0 *** (INTEGER) normalEnd(1)
Binding #4: hwNmNorthboundEventSynchronizationEndStatusDetail.0 *** (OCTET STRING) Sync End:
Successfully queried all alarms!
1.8.2.4.5 KeepAlive Info (Heartbeat) Trap
Function
iMaster NCE-Fabric regularly sends heartbeat traps to the third-party system in
each heartbeat period. If the third-party system receives the traps, the connection
between the third-party system and iMaster NCE-Fabric is normal. If the third-
party system does not receive traps within the heartbeat period and the heartbeat
is unavailable, the third-party system is disconnected from iMaster NCE-Fabric.
NOTE
A period ranges from 3 to 300 seconds, and is 60 seconds by default.
Trigger Condition
iMaster NCE-Fabric sends the KeepAlive info (heartbeat) trap to the OSS regularly
in the preset period.
Definition
hwNmNorthboundE- 1.3.6.1.4.1.2011.2.15.1.7.2. Trap/ Notification for

ventKeepAlive 0.2 Inform the Keep Alive
traps.
VB List
Name OID Data Type Descriptio
n
hwNmAgent 1.3.6.1.4.1.2011.2.15.1 OCTET STRING By default,

this field is
reported.

iMaster NCE-Fabric
Name OID Data Type Descriptio

n
hwNmNorthbound 1.3.6.1.4.1.2011.2.15.1.7.2.1 OCTET STRING You can

KeepAlive make
configurati
ons for the
heartbeat
notificatio
n trap to
report this
field.
NOTICE
By default, the heartbeat notification trap reports the hwNMAgent field. You can
make modifications for the trap to report the hwNmNorthboundKeepAlive field.
Example
The following is an example of the heartbeat trap complying with SNMPv3:
hwNmNorthboundEventKeepAlive
Transport: IP/UDP
Agent
Address: 10.185.199.167
Port: 6666
Manager
Address: 192.168.57.114
Port: 8899
Security parameters
Bindings (3)
Binding #2: snmpModules.1.1.4.1.0 *** (object identifier) hwNmNorthboundEventKeepAlive
Binding
1.8.2.5 MIB1 Trap Sample

MIB1 supports five types of traps: alarm notification trap, alarm synchronization
start trap, alarm synchronization result trap, alarm synchronization end trap, and
heartbeat trap. The samples in this section use SNMPv1 as an example. SNMPv2c
and SNMPv3 are similar to SNMPv1.

iMaster NCE-Fabric
1.8.2.5.1 Active Alarm Notification Trap
Description of the T2000support Configuration Item

The default value of the T2000support configuration item is 1. Check and change
the value before an upgrade to ensure compatibility. You must configure the item
manually.
mib1.T2000Support=0
13: Specific trap hwNmNorthboundEventInfo::hwNmNorthboundEventNotify #1 trap(v1)
received from: 10.71.224.13 at 2011-12-27 16:19:58
Time stamp: 0 days 00h:05m:29s.09th
Agent address: 10.71.224.13 Port: 6666 Transport: IP/UDP Protocol: SNMPv1 Trap
Manager address: 10.70.71.97 Port: 6666 Transport: IP/UDP
Community: ********
SNMPv1 agent address: 10.71.224.13
Enterprise: hwNmNorthboundEventInfo
Specific Trap MIB Lookup Results
Name: hwNmNorthboundEventNotify, Module: HW-IMAPV1NORTHBOUND-TRAP-MIB,
Bindings (24)
Binding #1: hwNmNorthboundNEName.0 *** (octets) NE(9-3500)
Binding #2: hwNmNorthboundNEType.0 *** (octets) OptiX OSN 3500
Binding #3: hwNmNorthboundObjectInstance.0 *** (octets) Slot=4 Port=1 TTP_TYPE=1 4-
N1SL16-1(SDH-1)-SPI:1
Binding #4: hwNmNorthboundEventType.0 *** (octets) Communication
Binding #5: hwNmNorthboundEventTime.0 *** (octets) 2011/04/27 - 16:11:30
Binding #6: hwNmNorthboundProbableCause.0 *** (octets) ID:1,DeviceType:0,
(1)The fiber jumper is not connected at the optical interface of the board;
(2)The laser of the board on the opposite station is shutdown;
(3)A fiber break occurs in the transm ...
Binding #7: hwNmNorthboundSeverity.0 *** (octets) Critical
Binding #8: hwNmNorthboundEventDetail.0 *** (octets) ID:1,DeviceType:0,Loss of signal
Binding #9: hwNmNorthboundAdditionalInfo.0 *** (octets)
Alarm Parameter(hex) 0x01 0x00 0x01 0x01 0x01
Binding #10: hwNmNorthboundFaultFlag.0 *** (octets) Fault
Binding #11: hwNmNorthboundFaultFunction.0 *** (octets) Communication
Binding #12: hwNmNorthboundDeviceIP.0 *** (ipaddr) 10.70.71.97
Binding #13: hwNmNorthboundSerialNo.0 *** (int32) 85415
Binding #14: hwNmNorthboundProbableRepair.0 *** (octets) ID:1,DeviceType:0,
Binding #15: hwNmNorthboundResourceIDs.0 *** (octets) 3145893.-1.4.1.1.1.-1.-1
Binding #16: hwNmNorthboundEventName.0 *** (octets) ID:1,DeviceType:0,R_LOS
Binding #17: hwNmNorthboundReasonID.0 *** (int32) 1
Binding #18: hwNmNorthboundFaultID.0 *** (int32) 1
Binding #19: hwNmNorthboundDeviceType.0 *** (octets) 0
Binding #20: hwNmNorthboundTrailName.0 *** (octets) PWE3:2
Binding #21: hwNmNorthboundRootAlarm.0 *** (int32) 0
Binding #22: hwNmNorthboundGroupID.0 *** (int32) 268374017
Binding #23: hwNmNorthboundMaintainStatus.0 *** (int32) 0
Binding #24: hwNmNorthboundRootAlarmSerialNo.0 *** (octets) (zero-length)
mib1.T2000Support=1
21: Specific trap hwNmNorthboundEventInfo::hwNmNorthboundEventNotify #1 trap(v1)
received from: 10.71.224.13 at 2011-4-27 16:25:24
Community: ********

iMaster NCE-Fabric

Name: hwNmNorthboundEventNotify, Module: HW-IMAPV1NORTHBOUND-TRAP-MIB,
Bindings (24)
Binding #2: hwNmNorthboundNEType.0 *** (octets) OptiX OSN 3500
Binding #3: hwNmNorthboundObjectInstance.0 *** (octets) source=NE(9-3500) location=4-
N1SL16-1(SDH-1)-SPI:1
Binding #6: hwNmNorthboundProbableCause.0 *** (octets)
(1)The fiber jumper is not connected at the optical interface of the board;
(2)The laser of the board on the opposite station is shutdown;
(3)A fiber break occurs in the transmission line;
(4) T ...
Binding #8: hwNmNorthboundEventDetail.0 *** (octets) Loss of signal
Alarm Parameter(hex) 0x01 0x00 0x01 0x01 0x01
Binding #12: hwNmNorthboundDeviceIP.0 *** (ipaddr) 10.70.71.97
Binding #14: hwNmNorthboundProbableRepair.0 *** (octets) (zero-length)
Binding #15: hwNmNorthboundResourceIDs.0 *** (octets) 3145893.-1.4.1.1.1.-1.-1
Binding #16: hwNmNorthboundEventName.0 *** (octets) R_LOS
1.8.2.5.2 Active Alarm Synchronization Start Trap

After the OSS sends alarm synchronization requests to iMaster NCE-Fabric, the
SNMP NBI will return the start notification of alarm synchronization.
18: Specific trap
hwNmNorthboundEventSynchronizationStart::hwNmNorthboundEventSynchronizationStartNotif
y #9 trap(v1) received from: 10.71.88.151 at 2010-11-24 15:56:45
Community: ********
Enterprise: hwNmNorthboundEventSynchronizationStart
Name: hwNmNorthboundEventSynchronizationStartNotify, Module: HW-
IMAPV1NORTHBOUND-TRAP-MIB, Enterprise: hwNmNorthboundEventSynchronizationStart
Bindings (0)
None.
1.8.2.5.3 Active Alarm Synchronization Reporting Trap

After the OSS sends alarm synchronization requests to iMaster NCE-Fabric, the
SNMP NBI will report the active alarms in compliance with the filter criteria to the
OSS.

iMaster NCE-Fabric
101: Specific trap

hwNmNorthboundEventSynchronizationQueryResult::hwNmNorthboundEventSynchronizationQu
eryResultNotify #10 trap(v1) received from: 10.71.88.151 at 2011-12-24 15:56:49
Community: ********
Enterprise: hwNmNorthboundEventSynchronizationQueryResult
Name: hwNmNorthboundEventSynchronizationQueryResultNotify, Module: HW-
IMAPV1NORTHBOUND-TRAP-MIB, Enterprise:
hwNmNorthboundEventSynchronizationQueryResult
Bindings (24)
Binding #2: hwNmNorthboundNEType.0 *** (octets) OptiX PTN 3900
Binding #3: hwNmNorthboundObjectInstance.0 *** (octets) TUNNEL:
(463,10.10.10.11,10.10.10.12)
Binding #6: hwNmNorthboundProbableCause.0 *** (octets) ID:12814,DeviceType:128450560,
1. The physical link fails.
2. The network is severely congested.
3. The opposite equipment is faulty.
Binding #8: hwNmNorthboundEventDetail.0 *** (octets) ID:12814,DeviceType:128450560,Loss
of Connectivity Verification defect
Alarm Parameter II(hex) 0x0f
Binding #12: hwNmNorthboundDeviceIP.0 *** (octets) 10.78.217.248
Binding #14: hwNmNorthboundProbableRepair.0 *** (octets) ID:12814,DeviceType:128450560,
Binding #15: hwNmNorthboundResourceIDs.0 *** (octets) 3145793.-1.-1.-1.-1.-1.-1.-1
Binding #16: hwNmNorthboundEventName.0 *** (octets) ID:12814,DeviceType:
128450560,MPLS_TUNNEL_LOCV
1.8.2.5.4 Active Alarm Synchronization End Trap

Active alarm synchronization end traps are triggered when all required alarms
have been reported to the OSS or the OSS automatically stops the
synchronization.
Synchronization Stopped After Alarm Reporting Was Complete

After all required alarms are reported to the OSS, iMaster NCE-Fabric sends traps
through the SNMP NBI to inform the OSS of the end of alarm reporting.
1335: Specific trap
hwNmNorthboundEventSynchronizationEnd::hwNmNorthboundEventSynchronizationEndNotify
#11 trap(v1) received from: 10.71.88.151 at 2010-11-24 15:57:45

iMaster NCE-Fabric
Community: ********
Enterprise: hwNmNorthboundEventSynchronizationEnd
Name: hwNmNorthboundEventSynchronizationEndNotify, Module: HW-
IMAPV1NORTHBOUND-TRAP-MIB, Enterprise: hwNmNorthboundEventSynchronizationEnd
Bindings (2)
Binding #1: hwNmNorthboundEventSynchronizationEndStatus.0 *** (int32) normalEnd(1)
Binding #2: hwNmNorthboundEventSynchronizationEndStatusDetail.0 *** (octets) Sync End:
Successfully queried all alarms!
Synchronization Was Stopped by the OSS

During the synchronization, the OSS automatically interrupts the process. iMaster
NCE-Fabric then reports traps to inform the OSS of the stop of alarm
synchronization, as a response to the request.
2420: Specific trap

Community: ********
Bindings (2)
Binding #1: hwNmNorthboundEventSynchronizationEndStatus.0 *** (int32) stopped(2)
Binding #2: hwNmNorthboundEventSynchronizationEndStatusDetail.0 *** (octets) Sync
Stopped: The synchronization is stopped by the NMS's command!
Synchronization Was Stopped Unexpectedly

403: Specific trap
Community: ********
Bindings (2)
Binding #1: hwNmNorthboundEventSynchronizationEndStatus.0 *** (int32) error(3)
Binding #2: hwNmNorthboundEventSynchronizationEndStatusDetail.0 *** (octets) Sync Error:
Query failed as Agent shutting down!
1.8.2.5.5 Heartbeat Trap

The SNMP NBI sends heartbeat traps to the OSS periodically. The OSS can check
the connection status based on the heartbeat traps.

iMaster NCE-Fabric
NOTE
Two OIDs are supported.
hwNmAgent (Default)
795: Specific trap hwNmNorthboundEventKeepAliveInfo::hwNmNorthboundEventKeepAlive #2
trap(v1) received from: 10.71.88.151 at 2010-11-24 15:57:20
Community: ********
Enterprise: hwNmNorthboundEventKeepAliveInfo
Name: hwNmNorthboundEventKeepAlive, Module: HW-IMAPV1NORTHBOUND-TRAP-MIB,
Bindings (1)
Binding #1: hwNmAgent *** (octets) SNMP Agent
hwNmNorthboundKeepAlive (Configurable-1.3.6.1.4.1.2011.2.15.1.7.2.1)
trap(v1) received from: 10.67.192.220 at 2012/6/26 11:19:13
Community: ********
Bindings (1)
Binding #1: hwNmNorthboundKeepAlive *** (octets) SNMP Agent
hwNmNorthboundKeepAlive (Configurable-1.3.6.1.4.1.2011.2.15.1.7.2.1.0)
trap(v1) received from: 10.78.219.70 at 2012/7/26 19:11:29
Community: ********
Bindings (1)
Binding #1: hwNmNorthboundKeepAlive.0 *** (octets) SNMP Agent
1.8.3 Collecting Interconnection Parameters

Interconnection parameters must be collected from the OSS's maintenance
engineers and confirmed before the SNMP NBI is configured to ensure that the
input parameters are correct. Otherwise, the OSS cannot receive alarms from or
connect to iMaster NCE-Fabric.
Table 1-21 and Table 1-22 list the information to be collected.

iMaster NCE-Fabric
For details about the parameter description, see 1.8.5.3 Configuration

Parameters.
Context
NOTICE
● Collect general parameters only and use default values for advanced
parameters.
● For iMaster NCE-Fabric upgrades, select the MIB structure carefully by referring
to 1.8.5.3.2 Advanced Configuration.
● For security purposes, the SNMP NBI does not support the following insecure
configuration items by default:
● Protocol version: SNMPv1 and SNMPv2c
● Security level: Not authenticated nor encrypted and Authenticated but not
encrypted
● Authentication protocol: MD5, SHA, and SHA2-224
● Encryption protocol: DES
● You can view, check, and modify the security configurations of the SNMP NBI in
Security Configuration. For details, see Security Configurations of the SNMP
NBI.
● SNMPv3 is recommended because it is securer than SNMPv1 and SNMPv2c.
Table 1-21 Basic settings
Parameter Description Default Value
Address for IP address used to send traps and IP address of

sending traps informs. If this parameter is set to an iMaster NCE-
invalid value, the northbound Fabric northbound
communication IP address will be communication IP
used. If multiple NICs are added, set address
this parameter to an IP address that
can communicate with the OSS.
Address for IP address used by the SNMP agent to IP address of

receiving requests receive requests from the OSS. iMaster NCE-
In the case of multiple NICs, set this Fabric northbound
parameter to the IP address that can communication IP
communicate with the OSS. address
Port for receiving Port of the SNMP service. It is used to 9812

requests receive requests from the OSS. The
default value is recommended.
Port for sending Port used to send traps and informs. 6666
traps The default value is recommended.

iMaster NCE-Fabric
Table 1-22 Advanced parameters

Parameter Description Default
Value
SNMP MIB type Type of the MIB structure to be loaded. mib1

Agent Currently, iMaster NCE-Fabric supports
Settin only MIB1.
gs ● mib1: The OIDs corresponding to HW-
IMAPV2NORTHBOUND-TRAP-
MIB.mib are supported.
● mib2: The OIDs corresponding to
IMAP_NORTHBOUND_MIB-V2.mib
are supported.
● mib3: The OIDs corresponding to
T2000-NETMANAGEMENT-MIB.mib
are supported. It is used only for
transport devices.
Alarm Interval for sending traps to the OSS. The 0

reporting value ranges from 0 to 1000.
interval
(ms)
Time type Type of the alarm reporting time. UTC time
Time Format of the alarm reporting time. UTC time in

format Currently, the UTC time, local time the format of
without the time zone, and local time (yyyy/MM/dd
with the time zone are supported. - hh:mm:ssZ)
For details, see 1.8.5.3.2 Advanced
Configuration.
Maximum Maximum length of a character string 4096

length of that in the VB.
reported
alarm
fields
Query Whether to query active alarms. Yes

active ● No: Current alarms will be queried.
alarms
● Yes: Active alarms will be queried.
Alarm Character set encoding format of the UTF-8

encoding reported alarm traps.
format ● UTF-8
● ISO-8859-1
● GBK

iMaster NCE-Fabric

Value
Record Whether to print PDU trace records in No

PDU in logs.
logs ● No: PDU trace records will not be
printed in logs.
● Yes: PDU trace records will be printed
in logs.
Filter Whether to report root alarms. No

correlative ● No: All alarms are reported, including
alarms common alarms, root alarms,
correlative alarms, and root and
correlative alarms.
● Yes: Only common alarms and root
alarms are reported.
Number of Cache size for real-time alarms. The value 10000

cached can range from 10000 to 50000.
alarms
Inform Alarm ● Inform: Alarms are reported in Trap

/Trap reporting informs.
Settin mode ● Trap: Alarms are reported in traps.
gs
Timeout This parameter is specified in the SNMP 5
period (s) inform protocol. It determines the
timeout period for sending inform
packets. The value can range from 1 to 5
seconds.
Number of This parameter is specified in the SNMP 3

retries inform protocol. It determines the
maximum number of times that an
inform packet can be retransmitted. The
value can range from 0 to 5.
SNMP Security By default, only secure protocols and Authenticated

v3 level algorithms are enabled. and
Param encrypted
eter
Settin Authentica Authentication protocol. SHA2-512
gs tion ● SHA2-256
protocol
● SHA2-384
● SHA2-512
Encryption Encryption protocol. AES-256

protocol ● AES-128
● AES-192
● AES-256

iMaster NCE-Fabric

Value
RFC Whether to convert the value of Engine Yes

specificati ID to comply with the RFC specifications.
ons ● Yes: Converts the Engine ID into a
value that complies with the RFC
specifications to report to the OSS.
● No: Directly reports the Engine ID to
the OSS.
Engine ID Engine ID, which is configurable and Engine ID

indicates the unique identifier of the automatically
SNMP entity. identified by
NOTE the system.
The value of Engine ID contains 5 to 32 The default
characters. Only combinations of the following
value is the IP
characters can be used: lowercase letters(a to
z), uppercase letters(A to Z), digits(0 to 9), address of
and special characters (=~!@#%^&*()-_+ the first NIC
[{}]:./?,) of the node
where
NBIService
service is
configured
Heart Report Whether to send heartbeat traps. Enable

beat heartbeat ● Disable: Heartbeat traps will not be
Period notificatio sent.
Settin ns
gs ● Enable: Heartbeat traps will be sent.
Heartbeat Period for sending heartbeat traps. The 60

period value of MIB1 ranges from 3 seconds to
(second) 300 seconds.
Heartbeat ID of a heartbeat trap. SNMP Agent

ID
SNMP Parameter Name of the configuration item of the -

NBI SNMP interface.
Advan
ced Value Name of the configuration item of the -
Param SNMP interface.
eter
Settin
gs
MIB Alarm Name of the NE where an alarm is -

Reporting Settings generated.
1.8.4 Important Notes

This section describes the important notes for configuring the SNMP NBI.

iMaster NCE-Fabric
Configuring the SNMP NBI may affect OSS and other components of iMaster NCE-
Fabric. Modifying configuration items may also depend on iMaster NCE-Fabric
components. Therefore, confirm whether the configuration items to be modified
will bring such type of impact and submit a request to the customer for approval
before configuring the SNMP NBI.
Table 1-23 Basic configuration parameters

Item Impact on iMaster NCE- Description
Fabric
Alarm Field The alarm fields will be Confirm the alarm fields
changed if you modify and the detailed fields
this configuration item. with the OSS, and then
The OSS may fail to set this configuration
parse the alarm. item.
Encoding Format The encoding format of Confirm the character

alarms reported by the set of the OSS, and then
SNMP NBI will be set this configuration
changed if you modify item correctly. The
this configuration item. character sets supported
The OSS may fail to include UTF-8, GBK, and
parse the alarm. ISO-8859-1. The
character sets of the
SNMP NBI and OSS must
be the same. If the
character set of the
SNMP NBI is different
from that of the OSS,
garbled characters may
be displayed during the
parsing.
MIB Frame The OSS may fail to Currently, iMaster NCE-

parse the alarm reported Fabric supports only
by the SNMP NBI if you MIB1. Confirm with the
modify this configuration OSS whether the MIB
item. structure used by the
OSS is MIB1. If HW-
IMAPV1NORTHBOUND-
TRAP-MIB.mib or HW-
IMAPV2NORTHBOUND-
TRAP-MIB.mib is used,
set this parameter to
MIB1.
Impact of Maintenance Operations on the NBIs

The NBI system is installed automatically during the installation of iMaster NCE-
Fabric. You need to configure NBI parameters manually to enable the functions.

iMaster NCE-Fabric
● If the iMaster NCE-Fabric server is configured with multiple NICs and they are
in different network segments, set the IP address for connecting to the OSS as
the IP address selected by the SNMP NBI for alarm reporting (By default, the
IP address is the northbound network communication IP address. If you
manually change the IP address, you need to reconfigure the NBI
synchronously.) is the IP address of the NIC for connecting to the OSS of the
iMaster NCE-Fabric server to ensure that the iMaster NCE-Fabric server and
the OSS can communicate with each other. Otherwise, the OSS cannot
interconnect with the NBI of iMaster NCE-Fabric.
● You must configure the NBI again after the IP address of iMaster NCE-Fabric
is changed. By default, the northbound communication IP address specified
during iMaster NCE-Fabric installation is used as Address for receiving
requests and Address for sending traps. If the northbound communication
IP address is changed, you need to manually update Address for receiving
requests and Address for sending traps as follows:
a. Management plane: Choose Maintenance > Network Configuration >
Configure IP Address or Configure Floating IP Address from the main
menu. Select Modify IP Address.
b. Control Plane: Open the System app and choose System Settings >
Northbound Interface from the main menu. In the navigation tree on
the left, choose SNMP NBI > Basic Settings and modify Address for
receiving requests and Address for sending traps in the right pane.
1.8.5 Configuring the SNMP NBI
1.8.5.1 Configuration Operations

After iMaster NCE-Fabric is installed, the SNMP NBI is installed by default.
However, you need to configure the SNMP NBI parameters according to the
iMaster NCE-Fabric plan to enable the SNMP NBI.
Prerequisites
● The iMaster NCE-Fabric license includes the SNMP NBI function.
● SNMP NBI processes are running.
Configuring the SNMP NBI

iMaster NCE-Fabric provides the SNMP NBI configuration page to configure the
interconnection parameters between iMaster NCE-Fabric and the NMS. Select
desired parameters based on customized requirements.
Generally, advanced parameters are optional (default values are recommended).
Advanced parameters are independent of each other and no configuration order is
required.

iMaster NCE-Fabric
Figure 1-10 Flowchart of configuring the SNMP NBI
Procedure
Step 1 Log in to the control plane as the admin user.
Step 2 Open the System app and choose System Settings > Northbound Interface from
the main menu..
Step 3 Choose SNMP NBI > Basic Settings from the navigation pane.
Step 4 On the Basic Settings page, set the IP addresses and port numbers for receiving
requests and sending traps.

iMaster NCE-Fabric
For details about the SNMP agent parameters, see 1.8.5.3.1 General Parameters.
1. Set the trap sending address/port and request receiving address/port.

By default, the trap sending port is 6666 and the request receiving port is
9812.
NOTICE
– Address for receiving requests and Address for sending traps both are
the iMaster NCE-Fabric server IP address. The SNMP NBI supports both
IPv4 and IPv6. If third-party system A requires IPv4 but third-party system
B requires IPv6, you can select both IPv4 and IPv6 addresses for the two
systems to communicate with at the same time. Ensure that this IP address
can be used for successful communication between iMaster NCE-Fabric
and the OSS.
– Refer to iMaster NCE-FabricCommunication Matrix before you configure
ports for the SNMP NBI. Before configuring these ports, ensure that the
specified ports are idle.
– The recommended port number is from 1025 to 32767.
2. In the case of SNMPv3, set the security level, authentication protocol, and
encryption protocol.
By default, iMaster NCE-Fabric supports SNMPv3.
On the Basic Settings page, click Advanced Settings > SNMPv3 Parameter
Settings. For details about SNMPv3 parameters, see SNMPv3 Parameter
Settings.

iMaster NCE-Fabric
NOTICE
In the case of SNMPv3, it is recommended that the OSS use the more secure SHA
and AES algorithms.
Step 5 Choose SNMP NBI > Third-party System Settings from the navigation pane, click
Create, and set the parameters of the OSS. The port must be set to 162 or 10162.
For details about the parameter description, see 1.8.5.3.3 Third-Party NMS.
1. Set the server parameters of the OSS.
The value of IPv4 address is the IP address of the OSS server.
NOTE
– The value of IPv4 address is not the IP address of the iMaster NCE-Fabric server
but the IP address of the OSS. If the OSS uses two servers to receive traps and send
requests, the IP addresses for these two servers must be configured separately.
– To configure multiple third-party system users, you are advised to set different
read-write community names (v1 or v2) for them, use different usernames (v3), or
ensure that not all usernames are identical. If not all read-write community names
(v1 or v2) are identical, duplicate usernames (v3) exist, and the passwords for
authentication and encryption are different, the interworking may fail for some
users.
– Currently a maximum of 10 OSSs are supported.
2. Set SNMP security parameters.
The following are the default security parameters. SNMPv3 is recommended
for security concern. In the case of SNMPv3, set V3 User Name, V3
Authentication Password, and V3 Privacy Password. The default username
is admin.

iMaster NCE-Fabric
NOTICE
In the case of SNMPv3, Security username is required.

To ensure the security of iMaster NCE-Fabric, change the passwords of
iMaster NCE-Fabric regularly.
The password must meet the following requirements to safeguard your user
account:
1. Contain 8 to 64 characters.
2. Not be the same as the username or the reverse of the username.
3. Not contain only repeated strings, such as aaaaaaaa, abababab, and
abcdabcd.
4. Consist of at least three of the following: lowercase letters (a–z), uppercase
letters (A–Z), digits (0–9), and special characters ~@#^*-_=+[{]};:./?.
3. On the page for creating an OSS, click Expand Filter Settings to set the
alarm filter criteria.
When setting filter criteria, you need to mask alarms of physical devices
(including CEs, NEs, and firewalls). The operations are as follows:
– Filter mode is Mask
i. Click next to Alarm sources.

ii. Click Add Alarm Sources.
iii. Select all CE, NE, and firewall physical devices in the list and click
OK.

iMaster NCE-Fabric
– Filter mode is Report

When setting the alarm source, do not select physical devices such as
CEs, NEs, or firewalls.
4. Click Create.
Step 6 (Optional) Set advanced parameters on the Advanced Settings area.
1. Specify whether to enable the heartbeat reporting, and set the reporting
period.
Report heartbeat Whether to send Enable

notifications heartbeat traps.
– Disable: Heartbeat
traps will not be
sent.
– Enable: Heartbeat
traps will be sent.

iMaster NCE-Fabric
Heartbeat period Period for sending 60

heartbeat traps. The
value of MIB1 ranges
from 3 seconds to 300
seconds. The value of
MIB2 ranges from 3
seconds to 3600
seconds. The default
value is 60 seconds.
Heartbeat ID ID of a heartbeat trap. SNMP Agent
2. Set the alarm fields to be reported.

On the Basic Settings page, click Advanced Settings > MIB Alarm
Reporting Settings, and select the check boxes on the left of the fields to be
reported.
3. Set the reporting mode and other relevant parameters.

SNMPv3 supports the inform mode. The inform parameters include Alarm
reporting mode, Timeout period (s), Number of retries, and Number of
cached alarms.

iMaster NCE-Fabric

Value
Alarm – Inform: Alarms are reported in informs. Trap

reporting – Trap: Alarms are reported in traps.
mode
Timeout Timeout period for sending inform packets. 5

period (s) This parameter is specified in the SNMP
inform protocol.
The unit is second. The minimum value is 1
and the default value is 5.
Number of Maximum number of times an inform 3

retries packet can be retransmitted. This parameter
is specified in the SNMP inform protocol.
The minimum value is 0.
4. Set basic information about the SNMP agent.

The SNMP agent parameters include MIB type,Trap sending interval, Time
type, Time format, Maximum length of reported alarm fields, Query
active alarms, alarm encording format ,Record PDU in logs, Filter
correlative alarms,and Number of cached alarms.

iMaster NCE-Fabric
MIB type mib1: The NMS uses mib1

the HW-
IMAPV1NORTHBOUND
-TRAP-MIB.mib or HW-
IMAPV2NORTHBOUND
-TRAP-MIB.mib MIB file.
– For details about the
supported alarm
fields (VB), see
1.8.2.3 Alarm Fields
Reported by MIB1.
– iMaster NCE-Fabric
supports only mib1.
mib2: The OSS uses the
MIB file
IMAP_NORTHBOUND_
MIB-V1.mib or
IMAP_NORTHBOUND_
MIB-V2.mib.
mib3: The NMS uses
the T2000-
NETMANAGEMENT-
MIB.mib MIB file.
Alarm reporting Interval for sending 0

interval (ms) traps to the OSS. The
value ranges from 0 ms
to 1000 ms.
Time type Type of the alarm UTC time

reporting time.
Time format Format of the alarm UTC time in the format

reporting time. of yyyy/MM/dd -
Currently, UTC time, hh:mm:ssZ
local time without time
zone, and local time
with time zone are
supported.
For details, see
1.8.5.3.2 Advanced
Configuration.
Maximum length of Maximum length of a 4096

reported alarm fields character string in the
VB.

iMaster NCE-Fabric
Query active alarms Whether to query Yes

active alarms.
– No: Current alarms
will be queried.
– Yes: Active alarms
will be queried.
Alarm encoding format Character set encoding UTF-8

format of the reported
alarm traps.
– UTF-8
– ISO-8859-1
– GBK
Record PDU in logs Whether to print PDU No

trace records in logs.
– No: PDU trace
records will not be
printed in logs.
– Yes: PDU trace
records will be
printed in logs.
Filter correlative alarms Whether to report No

correlative alarms.
– Yes: Only common
alarms and root
– No: Common
alarms, root alarms,
and correlative
Number of cached Cache size for real-time 10000

alarms alarms. The value can
range from 10000 to
50000.
NOTICE
The settings take effect only after you click Save.
5. Set advanced parameters about the SNMP interface.

Advanced parameters are optional (default values are recommended). Select
desired parameters based on customized requirements.

iMaster NCE-Fabric
Table 1-24 MIB1 parameters

Parameter Description Default value
EmsName Name of an EMS. Huawei/NCE
Delimiter Delimiter between character elements Space

in the ObjectInstance and
ResourceIDs fields.
The default delimiter for
ObjectInstance is space, and that for
ResourceIDs is period (.).
If the delimiter is longer than 1, the
first letter of the delimiter is taken.
ResIDFormat Whether to display the resource 1

information in FDN name-value
format. Set this parameter to 1.
NOTE
– 0: The ResourceIDs and
ObjectInstance fields are represented
as an FDN dotted notation, for
example, [3145731.-1.22.8.912.1.-1.-1].
– 1: The ResourceIDs and
ObjectInstance fields are represented
as an FDN name-value pair, for
example,
[NE=312323,FR=1,S=1,CP=1,PP=4|1|2|].
If an NBI compatibility ID has been set,
iMaster NCE-Fabric will adjust the EMS
ID and FDN format based on the
setting. For example, the EMS ID is
changed from OSS to OMC and the
FDN is changed from name-value
format to dotted format.
SupportX733Ala Whether the X733 standard is 0

rm supported. This parameter can be set
to:
– 0: The X733 standard is not
supported.
– 1: The X733 standard is supported.

iMaster NCE-Fabric
KeepAliveVBOID Type of heartbeat VB OIDs. This 1.3.6.1.4.1.2011

parameter is set to .2.15.1
1.3.6.1.4.1.2011.2.15.1 by default. It
can also be set to
1.3.6.1.4.1.2011.2.15.1.7.2.1.
NotifyOID Trap OIDs for alarms (MIB1 0

configuration switch). This parameter
can be set to:
– 0: The OID of the real-time alarm
trap is 1.3.6.1.4.1.2011.2.15.1.7.1.0.1.
– 1: The OIDs of real-time alarm traps
vary according to alarm severities.
The OIDs of trap traps at different
severities are as follows: Critical:
1.3.6.1.4.1.2011.2.15.1.7.1.0.3
Major:1.3.6.1.4.1.2011.2.15.1.7.1.0.4
Minor:1.3.6.1.4.1.2011.2.15.1.7.1.0.5
Warning:
1.3.6.1.4.1.2011.2.15.1.7.1.0.6
Indeterminate:
1.3.6.1.4.1.2011.2.15.1.7.1.0.7
Unknown_Severity:
1.3.6.1.4.1.2011.2.15.1.7.1.0.8
T2000Support Whether to enable T2000 fields such 1

as ObjectInstance, ProbableCause,
EventDetail, ProbableRepair, and
EventName. Set this parameter to 1.
SupportOldGrou MXU NE GroupID. 0

pID – 0: Use new GroupID.
– 1: Use old GroupID.
For MA5616, the new GroupID is 59,
and the old GroupID is 71.
severity_Critical Alarm severity name. Critical
severity_Major Alarm severity name. Major
severity_Minor Alarm severity name. Minor
severity_Warnin Alarm severity name. Warning

g
severity_Unrepo Alarm severity name. Unknown_Seve

rt rity
severity_Indeter Alarm severity name. Indeterminate

minate

iMaster NCE-Fabric
N2000Convert Whether to convert parameters such 0

as NEType, ProbableCause,
EventDetail, ProbableRepair,
EventName, ReasonID, FaultID, and
DeviceType.
– 0: Do not perform parameters
conversion.
– 1: Perform parameters conversion.
boardNameCom Content reported by the AdditionalVB1 0

patibility field.
– 0: Alarm object ID.
– 1: Board type.
NOTICE
The settings take effect only after you click Save.
Step 7 Log in to the iMaster NCE-Fabric management plane and check the SNMP service
status.
If the status is Running, the SNMP NBI has been enabled successfully.
1. Log in to the iMaster NCE-Fabric management plane.
2. Choose Maintenance > Operation and Maintenance Management >
Panoramic Monitoring from the main menu. In the navigation pane, choose
Service Monitoring.
3. On the Processes tab page, enter snmpagentservice in the search box and
process details page is displayed.
4. Check the running status of the snmpagentservice process on the displayed
page. The status of the service is Running.
5. On the Processes tab page, enter nbisnmpconfigwebsite in the search box

and process details page is displayed.
6. Check the running status of the nbisnmpconfigwebsite process on the
displayed page. The status of the service is Running.

iMaster NCE-Fabric
----End
1.8.5.2 Configuring a Security Policy

Security settings allow you to configure the lockout policy for the login IP address
after the SNMP NBI authentication fails. By default, if incorrect passwords are
entered for consecutive three times within 60 minutes, the login IP address will be
locked for 5 minutes.
Prerequisites
You have the Northbound Interface operation right.
Procedure
Step 1 Log in to the NCEO&M plane as the admin user.
Step 2 Open the System Settings app and choose System Settings > Northbound
Interface from the main menu.
Step 3 In the navigation pane, choose SNMP NBI > Security Settings.
Step 4 On the Security Settings page, retain the default settings.
Table 1-25 lists the SNMP NBI Security Policy parameters.
Table 1-25 Configuring a Security Policy

Value
Maximum number Maximum number of consecutive login 3

of login attempts failures on a client IP address.
Login period Period (in minutes) within which 60

consecutive login failures are measured.
Lockout duration Lock period (in minutes) after 5

consecutive login failures.
Step 5 Click Save.
----End

iMaster NCE-Fabric
1.8.5.3 Configuration Parameters

NCE can connect to the OSS after you correctly set general parameters on the NCE
NBI configuration page. You can also set advanced parameters to customize the
messages queried or reported through the SNMP NBI.
1.8.5.3.1 General Parameters

The SNMP NBI runs on NCE. It receives requests from the OSS, performs required
operations on NCE, and reports alarms to the OSS in real time. General
parameters for the SNMP NBI include the trap transmitting IP address or port,
request receiving IP address or port, and SNMP version.
Navigation Path
Log in to the control plane. Open the System app and choose System Settings >
Northbound Interface from the main menu. Choose SNMP NBI > Basic Settings
from the navigation pane.
Parameters
NOTICE
The trap sending address and request receiving address are both the NCE server IP
address (You are advised to use the default IP address, that is, the planned
network communication IP address of the SNMP NBI. If you select other IPv4
addresses, NCE may fail to communicate with third-party systems. The SNMP NBI
supports both IPv4 and IPv6. If third-party system A requires IPv4 but third-party
system B requires IPv6, you can select both IPv4 and IPv6 addresses for the two
systems to communicate with NCE at the same time.). Ensure that this IP address
can be used for successful communication between NCE and the OSS.
When configuring ports for the SNMP NBI, refer to iMaster NCE Communication
Matrix to prevent port conflicts.
On NCE, the recommended port number of the SNMP protocol is from 1025 to
32767.

iMaster NCE-Fabric
Parameter Description Value
Address for IP address used by an SNMP agent -

sending to receive requests from the upper-
traps layer NMS. The SNMP agent can
communicate with the upper-layer
NMS using this IP address. You are
advised to set this parameter to
the northbound floating IP
address.
● In the Manager+Controller
+Analyzer scenario with IP
address convergence, it is the
LVS-Northbound IP of the GW
node.
Port for Port for sending traps. 1024 to 65535

sending Default: 6666
traps
Address for IP address used by an SNMP agent -

receiving to send trap packets to the upper-
requests layer NMS. The SNMP agent can
communicate with the upper-layer
NMS using this IP address. You are
advised to set this parameter to
the northbound floating IP
address.
Port for Port of the SNMP service. It is used 1024 to 65535

receiving to receive requests from the upper- Default: 9812
requests layer NMS.
1.8.5.3.2 Advanced Configuration

You can set the advanced parameters for the SNMP NBI on the SNMP NBI
configuration page.
Navigation Path
1. Open the System app and choose System Settings > Northbound Interface
from the main menu..
2. Choose SNMP NBI > Basic Settings from the navigation pane.

iMaster NCE-Fabric
SNMP Agent Settings

Value
MIB type MIB1: The OSS uses the MIB file HW- MIB1
IMAPV1NORTHBOUND-TRAP-MIB.mib or HW-
IMAPV2NORTHBOUND-TRAP-MIB.mib.
● For details about the supported alarm fields (VB),
see 1.8.2.3 Alarm Fields Reported by MIB1.
● iMaster NCE-Fabric supports only MIB1.
MIB2: The OSS uses the MIB file
IMAP_NORTHBOUND_MIB-V1.mib or
IMAP_NORTHBOUND_MIB-V2.mib.
MIB3: The OSS uses the MIB file T2000-
NETMANAGEMENT-MIB.mib.
Alarm Interval at which alarms are reported. The value can 0

reporting range from 0 ms to 1000 ms.
interval
(ms)
Time type ● UTC time UTC time

● EMS time
● NE system time

iMaster NCE-Fabric

Value
Time Time format of the VB field that identifies alarm UTC time
format time. in the
● UTC time in the format of yyyy/MM/dd - format of
HH:mm:ssZ: uses the local time without the time yyyy/MM/
zone. dd -
HH:mm:ss
● Local time without the time zone in the format of Z
yyyy/MM/dd - HH:mm:ss: uses the UTC time
which has a different time format from the UTC
time used when this parameter is set to 0.
● Local time with the time zone in the format of
yyyy/MM/dd - HH:mm:ssTZ[DST]
● UTC time in the format of yyyy-MM-dd HH:mm:ss
● Local time in the format of yyyy-MM-dd
HH:mm:ss + hh:mm TZ + hh:mm DST
● Local time without the time zone in the format of
yyyy-MM-dd,HH:mm:ss.0
Maximum 255-4096 4096

length of
reported
alarm
fields
Query Whether to query active alarms. Yes

active ● Yes: Active alarms will be queried.
alarms
● No: Current alarms will be queried.
NOTE
● Active alarms refer to uncleared and
unacknowledged alarms, and uncleared but
acknowledged alarms.
● Current alarms refer to uncleared and
unacknowledged alarms, cleared but
unacknowledged alarms, and uncleared but
acknowledged alarms.
Alarm Character set encoding format of the reported alarm UTF-8

encoding traps.
format ● UTF-8
● ISO-8859-1
● GBK
Record Whether to print PDU trace records in logs. No

PDU in logs ● No: PDU trace records will not be printed in logs.
● Yes: PDU trace records will be printed in logs.

iMaster NCE-Fabric

Value
Filter Whether to report correlative alarms. No

correlative ● Yes: Only common alarms and root alarms are
alarms reported.
● No: Common alarms, root alarms, and correlative
Number of Cache size for real-time alarms. The value can range 10000
cached from 10000 to 50000.
alarms
NOTICE
This setting has a direct impact on the successful communication between iMaster
NCE-Fabric and the OSS for alarm management. Confirm with the OSS when
setting the MIB frame.
Inform/Trap Settings
You can set the reporting mode and the relevant parameters.
CAUTION
● Trap mode: A received alarm is reported immediately regardless of whether the

OSS returns a response to the previous alarm reporting.
● Inform mode: A received alarm is reported immediately after the OSS returns a
response to the previous alarm reporting or the number of retry attempts is
exceeded. In this mode, if the parameters configured for the OSS are incorrect,
the SNMP agent tries connecting to the OSS for many times. This will occupy a
large number of resources. As a result, the efficiency of the SNMP agent is
reduced. Therefore, exercise caution when you set this parameter to Inform.

Value
Alarm reporting ● Inform: Alarms are reported in informs. Trap

mode ● Trap: Alarms are reported in traps.
Timeout period Timeout period for sending inform packets. This 5

(s) parameter is specified in the SNMP inform
protocol. The unit is second. The minimum
value is 1 and the default value is 5.

iMaster NCE-Fabric

Value
Number of Maximum number of times an inform packet 3

retries can be retransmitted. This parameter is
specified in the SNMP inform protocol. The
minimum value is 0.
SNMPv3 Parameter Settings

Value
Security Level Security level. This parameter can only be set Authenticated
to Authenticated and encrypted by default. and encrypted
Authenticatio Authentication protocol, which can be set to: SHA2-512

n protocol ● SHA2-256
● SHA2-384
● SHA2-512
Encryption Encryption protocol of SNMPv3, which can be AES-256

protocol set to:
● AES-128
● AES-192
● AES-256
RFC Whether to convert the value of Engine ID to Yes

specifications comply with the RFC specifications.
● Yes: Converts the Engine ID into a value
that complies with the RFC specifications to
report to the OSS.
● No: Directly reports the Engine ID to the
OSS.
Engine ID Engine ID, which is configurable and indicates Engine ID

the unique identifier of the SNMP entity. automatically
NOTE identified by
The value of Engine ID contains 5 to 32 characters. the system.
Only combinations of the following characters are
The default
allowed: lowercase letters (a–z), uppercase letters
(A–Z), digits (0–9), spaces and special characters =~! value is the IP
@#%^&*()-_+[{}]:./?,. address of the
Engine ID cannot start or ends with spaces. first NIC of
the node
where
NBIService
service is
configured

iMaster NCE-Fabric
Heartbeat Period Settings

iMaster NCE-Fabric can periodically send heartbeat information to the OSS
through the SNMP NBI. Based on the heartbeat information, the OSS determines
whether the communication is successful.
Table 1-26 Heartbeat parameters

Report Whether to send heartbeat traps. Enable

heartbeat ● Disable: Heartbeat traps will not be
notifications sent.
● Enable: Heartbeat traps will be
sent.
Heartbeat Period for sending heartbeat traps. The 60

period(second value of MIB1 ranges from 3 seconds
) to 300 seconds. The value of MIB2
ranges from 3 seconds to 3600
seconds. The default value is 60
seconds.
Heartbeat ID ID of a heartbeat trap. SNMP Agent
SNMP NBI Advanced Parameter Settings

Value
Parameter Name of the configuration item of the SNMP EmsName

interface.
● EmsName
● Delimiter
● ResIDFormat
● SupportX733Alarm
● KeepAliveVBOID
● NotifyOID
● T2000Support
● SupportOldGroupID
Value Name of the configuration item of the SNMP Huawei/NCE

interface.
MIB Alarm Reporting Settings

The reported alarm field, also called VB, specifies the alarm information to be
reported through the SNMP NBI.

iMaster NCE-Fabric
NOTICE
● This parameter is applicable to all third-party NMSs connected to the SNMP

NBI.
● iMaster NCE-Fabric automatically fills the alarm field.

Name Name in the Description Value Parsing
MIB Supported
NE hwNmNorthb Name of the NE where an Octet No

Name oundNENam alarm is generated. string
e ● For alarms generated on
an NE, the NE name is
reported.
● For alarms generated due
to NE disconnection, the
NE name is reported. For
example, if alarms are
generated due to NE
login failures or NE
disconnection, the NE
name is reported.
● For other NMS alarms,
the NMS name is
reported. By default, OSS
is reported. If the NMS
name is changed, the
name of the changed
NMS is reported.
NE Type hwNmNorthb Type of the NE on which Octet No

oundNEType alarms are generated. For string
NMS alarms, the NMS name
is reported.
Object hwNmNorthb Location information. For Octet No

instance oundObjectIn details, see Table3 Location string
stance information format.

iMaster NCE-Fabric

MIB Supported
Event hwNmNorthb Alarm type. For non-X.733- Octet Yes. See

Type oundEventTy compliant alarms, options string the
pe are as follows: enumerate
● Environment d value.
● Equipment
● Communication
● Service
● Process
● Security
For X.733-compliant alarms,
● EnvironmentalAlarm
● EquipmentAlarm
● CommunicationsAlarm
● QualityofServiceAlarm
● ProcessingErrorAlarm
● SecurityAlarm

iMaster NCE-Fabric

MIB Supported
Alarm hwNmNorthb Time when an alarm is Octet Yes. See

Occurren oundEventTi generated, cleared, string the time
ce Time me acknowledged, format.
unacknowledged, or
changed.
● If an alarm is generated,
this parameter indicates
the time when the alarm
is generated.
● If an alarm is cleared, this
parameter indicates the
cleared.
● If an alarm is
acknowledged, this
acknowledged.
● If an alarm is
unacknowledged, this
unacknowledged.
● If an alarm is changed,
this parameter indicates
the time when the alarm
is changed.
The options can be in any of
the following formats:
YYYY/MM/DD -
hh:mm:ssZ, for example,
2009/12/23 - 11:30:30Z.
● Local time without the
time zone. The format is
YYYY/MM/DD -
hh:mm:ss, for example,
2009/12/23 - 19:30:30.
● Local time with the time
zone. The format is
YYYY/MM/DD -
hh:mm:ss,
hh:mmTZ[DST], where
TZ stands for the time
zone information and
DST stands for the DST

iMaster NCE-Fabric

MIB Supported
offset. The following lists

examples:
– 2009/12/23 - 19:30:30,
+08:00[0] (The date is
not in DST.)
– 2009/12/23 - 19:30:30
+08:00[3600] (The
DST offset is 1 hour.
The DST value is
represented in
seconds.)
● Local time. The format is
YYYY-MM-dd hh:mm:ss
+ hh:mm TZ + hh:mm
DST, where TZ stands for
the time zone
information and DST
stands for the DST offset.
The following lists
examples:
– 2009-12-23 19:30:30
+ 08:00 TZ (The date is
not in DST.)
– 2009-12-23 19:30:30
+ 08:00 TZ + 01:00 DST
(The DST offset is 1
hour.)
YYYY-MM-dd hh:mm:ss,
for example, 2009-12-23
11:30:30.
Alarm hwNmNorthb Possible causes for an alarm. Octet No

Cause oundProbabl Format: ID:[Alarm string
eCause ID],DeviceType:[DeviceType
ID],Alarm Cause
Alarm hwNmNorthb Alarm severity. Octet Yes. See

Severity oundSeverity ● Critical string the
enumerate
● Major d value.
● Minor
● Warning
● Cleared: This option is
supported for X.733-
compliant alarms.

iMaster NCE-Fabric

MIB Supported
Alarm hwNmNorthb ID, device type, and details Octet No

Details oundEventDe of an alarm. string
tail Format: ID:
[AlarmID],DeviceType:
[DeviceType ID],Alarm
Details
Alarm hwNmNorthb Specific location of the NE Octet No

Location oundAddition where an alarm is string
alInfo generated.
Type hwNmNorthb Alarm type. Options are as Octet Yes. See

Flag oundFaultFla follows: string the
g ● Event: indicates that an enumerate
event is generated. d value.
alarm is generated.
that the alarm is
acknowledged.
● Unacknowledge:
indicates that the alarm is
unacknowledged.
● Change: indicates that
the alarm is changed.
Alarm hwNmNorthb Alarm type based on Octet Yes. See

Function oundFaultFun functions, which is the same string the
Category ction as hwNmNorthboundEvent- enumerate
Type. d value.
Manage hwNmNorthb IP address of the NE. IP No

d oundDeviceIP address
Equipme
nt
Address
Alarm hwNmNorthb Sequence number of an Integer No

Serial oundSerialNo alarm.
Number
Alarm hwNmNorthb Advice for clearing alarms. Octet No

Clearanc oundProbabl Format: ID: string
e Advice eRepair [AlarmID],DeviceType:
[DeviceType ID], Alarm
Clearance Advice

iMaster NCE-Fabric

MIB Supported
Resource hwNmNorthb ID of the resource where an Octet No

ID oundResourc alarm is generated. string
eIDs
Event hwNmNorthb Name of an alarm. Octet No

Name oundEventNa Format: ID: string
me [AlarmID],DeviceType:
[DeviceType ID],Event Name
Alarm hwNmNorthb Alarm cause ID. Integer No

Cause ID oundReasonI
D
Alarm ID hwNmNorthb Alarm ID. Integer No

oundFaultID
Manage hwNmNorthb Managed device type. Octet No

d oundDeviceTy string
Equipme pe
nt Type
Trail hwNmNorthb Name of the trail affected by Octet No

Name oundTrailNa an alarm. If alarm A affects string
me a trail, a new change alarm
B will be generated. The
sequence number of alarm B
is the same as that of alarm
A. The severity of alarm B is
Change. Trail Name in
alarm B indicates the
affected trail. However, for
alarm A, Trail Name is
blank.
Root hwNmNorthb Whether the alarm is the Integer Yes. See

Alarm oundRootAlar root alarm or not. Options the
m are as follows: enumerate
● 0: Non-root alarm d value.
● 1: Root alarm
Group ID hwNmNorthb ID of the alarm group. Integer No

oundGroupID

iMaster NCE-Fabric

MIB Supported
Engineer hwNmNorthb Whether this alarm is Integer Yes. See

ing oundMaintai generated by the NE in the the
Alarm nStatus engineering maintenance enumerate
Status state. Maintenance d value.
engineers can focus on
engineering alarms
selectively.
● 0: Non-engineering
alarms
● 1: Engineering alarms
NOTE
NEs during engineering
commissioning or service
cutover generate a large
number of alarms, and you can
set the NEs to the engineering
maintenance state. Therefore,
the alarms generated by this
kind of NE are engineering
alarms.
Root hwNmNorthb Log sequence number of the Octet No

Alarm oundRootAlar root alarm. string
Serial mSerialNo
Number
Alarm hwNmNorthb Alarm acknowledgement Integer Yes. See

Acknowl oundConfirm status. the
edgeme Status ● 1: acknowledged enumerate
nt Status d value.
Alarm hwNmNorthb Alarm clearance status. Integer Yes. See

Clearanc oundRestoreS ● 1: cleared the
e Status tatus enumerate
● 2: uncleared d value.
Alarm hwNorthbou Indicates the alarm UUID of String No

addition ndAdditional the physical resources (NEs,
al VB1 boards, and ports) in the IP
informat domain.
ion 1
Alarm hwNorthbou Reserved field, which is not String No

addition ndAdditional enabled currently.
al VB2
informat
ion 2

iMaster NCE-Fabric

MIB Supported
Alarm hwNorthbou When iMaster NCE-Fabric String Yes. See

addition ndAdditional interconnects with eSight, the
al VB3 select this parameter to enumerate
informat specify whether the current d value.
ion 3 alarm is automatically
cleared (ADAC) or manually
cleared (ADMC).
● 1: ADAC
● 2: ADMC

al VB4
informat
ion 4

al VB5
informat
ion 5

al VB6
informat
ion 6

al VB7
informat
ion 7

al VB8
informat
ion 8
1.8.5.3.3 Third-Party NMS

The third-party NMS refers to the NMS (also called SNMP manager) in the SNMP
protocol. For the SNMP NBI, the third-party NMS functions as the OSS. The third-
party NMS sends requests to the SNMP agent, receives responses or traps from
the SNMP agent, parses these packets, and displays the result.

iMaster NCE-Fabric
Navigation Path
from the main menu. on the control plane.
2. In the navigation pane, choose SNMP NBI > Third-party System Settings.
3. On the Third-party System Settings page, click Create and set third-party
NMS parameters.
Parameters
NOTE
● SNMPv3 is recommended, because it is more secure than SNMPv1 and SNMPv2c. Before
setting Protocol version to SNMPv1 or SNMPv2c, set SNMP Insecure Switch to
Enable for Northbound interface-SNMP insecure configuration switch. For details,
see Checking Security Configurations.
● The value of IPv4 address is not the IP address of the iMaster NCE-Fabric server but the
IP address of a third-party NMS at the upper layer. If the third-party NMS uses two
servers to receive traps and send requests, the IP addresses for these two servers must
be configured separately. Currently a maximum of 10 third-party NMSs are supported.
Table 1-28 lists the configuration requirements of the third-party NMS.
Table 1-28 Configuration requirements of the third-party NMS

MIB SNMP Configuration Requirements
Type Version
MIB1 v1/v2c You are advised to set different read/write community

names for third-party NMSs. If multiple third-party NMSs
(for example, NMS 1 and NMS 2) use the same read/
write community names, ensure that the SNMP protocol
versions used by the NMSs are the same.
v3 You are advised to set different usernames for third-party

NMSs. If multiple third-party NMSs (for example, NMS 1
and NMS 2) use the same username, the same
authentication password or encryption password must be
set for all the NMSs.

iMaster NCE-Fabric
NOTICE
To ensure the security of iMaster NCE-Fabric, change the default passwords of

iMaster NCE-Fabric and change the passwords regularly.
The password must meet the following requirements to safeguard your user
account:
1. Contain 8 to 64 characters.
2. Contain at least four of the following:
● Lowercase letters (a–z)
● Uppercase letters (A–Z)
● Digits (0–9)
● Special characters such as `~!@#$%^&*()-_=+\|[{}];:'",<.>/? and spaces
Table 1-29 lists the parameters for the upper-layer NMS.
Table 1-29 Parameters for the upper-layer NMS

IP address IP address type of the OSS. IPv4

type ● IPv4
● IPv6
IPv4 address IP address used by the OSS to receive None

(or IPv6 traps.
address)
Port Port used by the OSS to receive traps. 8899

IPv4 address (or IPv6 address) and
Port determine the destination of real-
time alarm traps, current alarm query
traps, and heartbeat traps. The port
must be set to 162 or 10162.
Protocol SNMP version. Only SNMPv3 is SNMPv3

version supported by default.
Read Read community name when SNMPv1 None

community or SNMPv2c is used.
Write Write community name when SNMPv1 None

community or SNMPv2c is used.
It is recommended that the parameter
value be different from that of Read
community.
Security SNMPv3 security user. None

username

iMaster NCE-Fabric
Authorizatio Authentication password of the OSS None

n password user. This parameter is used when
SNMPv3 authentication is enabled.
Data Data encryption password of the OSS None

encryption user. This parameter is used when
password SNMPv3 encryption is enabled.
It is recommended that the parameter
value be different from that of
Authorization and authentication
password.
Filter Settings
NOTE
Filter settings ensure that the third-party or upper-layer NMS servers will receive the alarms
they need.
Table 1-30 Filter settings

Filter mode How to filter alarms and Mask

events. The options are
as follows:
● Mask
● Report
Effective mode How the filter mode Any criterion

takes effect. The options
are as follows:
● Any criterion
● All criteria

iMaster NCE-Fabric
Alarm severity Severities used to filter ● If Filter mode is set

alarms. Multiple to Mask, all the
severities can be options are
selected. Alarms at the deselected.
selected severities will be ● If Filter mode is set
reported or masked, to Report, all the
depending on the value options are selected.
of Filter mode. The
● Critical
● Major
● Minor
● Warning
Alarm category Categories used to filter ● If Filter mode is set

alarms. Multiple to Mask, all the
categories can be options are
selected. Alarms in the deselected.
selected categories will ● If Filter mode is set
be reported or masked, to Report, all the
depending on the value options are selected.
of Filter mode. The
● Fault alarm
● Clear alarm
● Acknowledge alarm
● Unacknowledge
alarm
● Change alarm
● Event
Engineering alarm Whether to filter ● If Filter mode is set

engineering alarms. The to Mask, the option is
option is as follows: deselected.
● Engineering alarms ● If Filter mode is set
to Report, the option
is selected.

iMaster NCE-Fabric
Alarm mode Modes used to filter Blank

alarms and events.
Multiple modes can be
selected. Alarms in the
selected modes will be
reported or masked,
depending on the value
of Filter mode.
● All
● NORMAL
● GSM
● UMTS
● LTE
● COMM
● NB-loT Cell
● FDD Cell
● TDD Cell
● RFA
● LTE Other
● NR
Add source types Source types used to Blank

filter alarms. Multiple
source types can be
selected. Alarms from
the selected types of
sources will be reported
or masked, depending on
the value of Filter mode.
For details, see Alarm
Source Types.
Alarm sources Sources used to filter Blank

alarms. Multiple sources
can be selected. Alarms
from the selected
sources will be reported
or masked, depending on
For details, see Alarm
Sources.

iMaster NCE-Fabric
Alarms Alarms or events to Blank

filter. Multiple alarms or
events can be selected,
which will be reported or
masked, depending on
For details, see Alarms.
Alarm Source Types

Step 1 In the Alarm source types area, click Add Alarm Source Types.
Step 2 In the Available area, select the NEs whose alarms need to be masked or
reported, and click .
Step 3 Click OK.
----End
Alarm Sources
Step 1 In the Alarm sources area, click Add Alarm Sources.
Step 2 In the Available area, select the NEs whose alarms need to be masked or
reported.
Step 3 In the Selected area, select the NEs set in Step 2 and click OK.
----End
Alarms
Step 1 In the Alarms area, click Add Alarms/Events.
Step 2 In the Available area, select the alarms or events that need to be masked or
reported, and click .
Step 3 In the Selected area, select the alarms or events set in Step 2 and click OK.
----End
1.8.6 Testing the SNMP NBI

This chapter describes how to check whether the SNMP NBI functions properly
and whether it is successfully interconnected with the OSS.

iMaster NCE-Fabric
1.8.6.1 MIB1
This section describes how to verify the running status of the SNMP NBI after the
MIB1 is loaded. The MIB1 includes HW-IMAPV1NORTHBOUND-TRAP-MIB.mib
and HW-IMAPV2NORTHBOUND-TRAP-MIB.mib.
Prerequisites
● SnmpAgentService is correctly configured.
● NbiSnmpConfigWebsite is correctly configured.
● The SNMP heartbeat information is configured.
– Heartbeat Period: 60s
– Report Heartbeat Info: yes
Procedure
Step 1 Log in to the iMaster NCE-Fabric management plane and check the SNMP service
status.
If the status is Running, the SNMP NBI has been enabled successfully.
1. Log in to the iMaster NCE-Fabric management plane.
2. Choose Maintenance > Operation and Maintenance Management >
Panoramic Monitoring from the main menu. In the navigation pane, choose
Service Monitoring.
3. On the Processes tab page, enter snmpagentservice in the search box and
process details page is displayed.
4. Check the running status of the snmpagentservice process on the displayed
page. The status of the service is Running.
5. On the Processes tab page, enter nbisnmpconfigwebsite in the search box

and process details page is displayed.
6. Check the running status of the nbisnmpconfigwebsite process on the
displayed page. The status of the service is Running.
If the SNMP NBI process fails to be started, see SNMP Service Process Fails to
Be Started for troubleshooting.
Step 2 Check whether heartbeat messages are received on the related OSS port.

iMaster NCE-Fabric
If no heartbeat message is received, see OSS Cannot Receive Heartbeat

Information for troubleshooting.
----End
1.8.7 Configuring the SNMP NBI on the OSS

1.8.7.1 Configuring the SNMPv3 NBI
Compared with SNMPv1 and SNMPv2c, the SNMPv3 NBI is characterized by
higher security due to its user-based security model. In this model, usernames and
passwords are used for access authentication and packet data is encrypted.
Prerequisites
● The SNMP version is set to SNMPv3, and Authenticated and encrypted is
selected from the Security level drop-down list (navigation path: Advanced
Settings > SNMPv3 Parameter Settings).
● The OSS has been created and the OSS server can receive real-time alarms or
heartbeats from iMaster NCE-Fabric.
Procedure
Step 1 Confirm SNMP NBI parameters with the iMaster NCE-Fabric administrator.
1. Log in to the control plane as the admin user.
from the main menu..
3. Choose SNMP NBI > Third-party System Settings from the navigation pane.
4. Locate the OSS in the list and click in the Operation column.
On the displayed page, set the OSS parameters.
Parameter Description Default Navigation Path
Value
IP address IP address IPv4 In the Third-party System

type type of the Settings area, view IP address
OSS. type.
– IPv4
– IPv6
IPv4 IP address None In the Third-party System

address (or used by the Settings area, view IPv4
IPv6 OSS to receive address (or IPv6 address).
address) traps.

iMaster NCE-Fabric

Value
Port Port used by 8899 In the Third-party System

the OSS to Settings area, view Port.
receive traps.
IPv4 address
(or IPv6
address) and
Port
determine the
destination of
real-time
alarm traps,
current alarm
query traps,
and heartbeat
traps.
Protocol SNMP version v3 In the Third-party System

version for the SNMP Change the Settings area, view Protocol
NBI. value to v3 version.
if SNMPv3
is used.
Security Security level, Authenticat In the Advanced Settings >

level including ed and SNMPv3 Parameter Settings
Authenticate encrypted area, view Security level.
d and
encrypted.
Authentica Authenticatio HMACSHA In the Advanced Settings >

tion n algorithm, SNMPv3 Parameter Settings
protocol including area, view Authentication
SHA2-256, protocol.
SHA2-384,
and
SHA2-512.
Encryption Encryption AES-256 In the Advanced Settings >

protocol algorithm, SNMPv3 Parameter Settings
including area, view Encryption
AES-128, protocol.
AES-192, and
AES-256.

iMaster NCE-Fabric

Value
RFC Whether to Yes In the Advanced Settings >

specificatio convert the SNMPv3 Parameter Settings
ns value of area, view RFC specifications.
Engine ID to
comply with
the RFC
specifications.
Yes: Converts
the Engine ID
into a value
that complies
with the RFC
specifications
and then
reports the
converted
value to the
OSS.
No: Directly
reports the
Engine ID to
the OSS.
Engine ID Engine ID, Engine ID In the Advanced Settings >

which is automatical SNMPv3 Parameter Settings
configurable ly identified area, view Engine ID.
and indicates by the
the unique system.
identifier of The default
the SNMP value is the
entity. IP address
NOTE of the first
The value of NIC of the
Engine ID
node where
contains 5 to
32 characters. NBIService
Only service is
combinations configured.
of the
following
characters can
be used:
lowercase
letters,
uppercase
letters, digits,
and special
characters
(=~!@#
%^&*()-_+
[{}]:./?,)

iMaster NCE-Fabric

Value
Security Username for None In the Third-party System

username authentication Settings area, view Security
. username.
Authorizati Authenticatio - In the Third-party System

on and n password. Settings area, view
authentica Authorization and
tion authentication password
password from the administrator.
Data Data - In the Third-party System

encryption encryption Settings area, view Data
password password. encryption password from the
administrator.
Step 2 Configure the OSS based on the preceding parameters set on iMaster NCE-Fabric.
CAUTION
Confirm with the iMaster NCE-Fabric administrator before modifying parameter

settings. Otherwise, the connection may fail.
----End
Follow-up Procedure
When viewing OSS information, you can perform the following operations:
● Click to modify the OSS information.

When Protocol version is configured as SNMPv3, if you want to change the
values of Authorization and authentication password and Data encryption
password, select Change password to modify the setting. If you do not need
to modify the settings, deselect Change password.
● Click to delete the OSS.
1.8.8 Calling the SNMP NBI
About This Chapter

The OSS calls the SNMP NBI to perform operations such as alarm synchronization
on NCE. Available subinterfaces vary with the loaded MIB.
NOTE
Ensure that the OSS has been connected to NCE through the SNMP NBI and the desired
operations have been licensed for use.

iMaster NCE-Fabric
1.8.8.1 MIB1 Subinterfaces

When the OSS is loaded with the MIB1, the SNMP NBI provides subinterfaces to
enable the following functions: reporting alarms automatically, synchronizing,
clearing, acknowledging, unacknowledging, and filtering alarms.
NOTICE
Ensure that the MIB1 has been loaded to the OSS. To load the MIB1, set the MIB
type to MIB1 when configuring the SNMP NBI.
1.8.8.1.1 Reporting Real-Time Alarms

You do not need to set any parameters for the OSS to receive alarm packets from
NCE through the SNMP NBI. After the SNMP NBI is properly configured on NCE,
alarms will be reported to the OSS in real time.
The SNMP NBI has been configured on NCE.
After the trap receiving IP address or port and SNMP version have been set for the
OSS on NCE, the OSS can receive real-time alarms.
You do not need to set related parameters on the OSS. Ensure that the OSS is
properly connected to NCE and the related ports are permitted by the firewall.
For details about how to configure the SNMP NBI, see Configuring the SNMP NBI.
1.8.8.1.2 Changing Filter Criteria

The SNMP NBI allows the OSS to dynamically change filter criteria for reporting
required alarms during its running.
Function
The OSS can call the alarm filtering interface to change alarm filter criteria
dynamically when the SNMP NBI is running.
MIB Definition
The OID is 1.3.6.1.4.1.2011.2.15.1.3.5.
The full path is as follows:
.hwNetManagement(15).hwNmAgent(1).hwNmFault(3).thirdNMSFaultFilter(5)
Node Data Type Maximum Access Description

Permission
thirdNMSFaultFil- OCTET STRING read-write Alarm filter

ter criteria are
changed
dynamically.

iMaster NCE-Fabric
Setting Method
The OSS can set the value of the MIB node to change the alarm filter criteria. The
format is as follows:
IPAddress:Port:AlarmFilterLevel:AlarmCategoryFilter
NOTICE
● The thirdNMSFaultFilter node only supports the set operation, that is, only the
write attribute is enabled. Therefore, you need to query the setting results of
the thirdNMSFaultFilter node on the NCE SNMP NBI configuration page.
● When you set the OID of the MIB node, you must add .0 to the end of the
original OID of the MIB node.
Table 1-31 Format description - changing filter criteria
IPAddress IP address used by the OSS. This IP address is the trap receiving
IP address preset when the SNMP NBI is configured.
Port Port used by the OSS. This port is the trap receiving port preset
when the SNMP NBI is configured.
AlarmFilterL Alarm severity.

evel Four binary digits are used to represent critical, major, minor, or
warning in descending order.
Each binary digit can be set to 0 or 1.
● 1: indicates that the alarms of the corresponding alarm
severity are filtered out and the OSS cannot receive alarms of
that severity.
● 0: indicates that the alarms of the corresponding alarm
severity are reported and the OSS can receive alarms of that
severity.
AlarmCateg Category of an alarm.

oryFilter Six binary digits are used to represent event, fault, clear,
acknowledge, unacknowledge, or change alarm in descending
order.
● 1: indicates that the alarms of the corresponding category are
filtered out and the OSS cannot receive alarms of the
category.
● 0: indicates that the alarms of the corresponding category are
reported and the OSS can receive alarms of the category.

iMaster NCE-Fabric
Sample
Prerequisites
● The IP address of the OSS is set to 10.70.73.97 and the port for receiving
alarms is set to 6666.
● The OSS connects to the SNMP NBI and can receive heartbeats or real-time
alarms.
Purpose
To change the filter criteria so that only critical or major fault and clear alarms are
reported.
The following table lists the parameters of this sample.
Table 1-32 Sample parameters - changing filter criteria

Parameter Value MIB Object
The IP of the upper-layer 10.70.73.97 10.70.73.97

NMS
Receive Trap Port 6666 6666
Alarm Severity to be Critical, Major 0011

Reported
Alarm Category to be Fault Alarm, Clearance 100111

Reported Alarm
Procedure
1. The OSS sets the OID of the thirdNMSFaultFilter node to:
1.3.6.1.4.1.2011.2.15.1.3.5.0.
2. The OSS sets thirdNMSFaultFilter to:
10.70.73.97:6666:0011:100111.
The OSS receives responses from NCE, indicating that the filter criteria are
changed successfully. The OSS will then receive the required alarms only.
1.8.8.1.3 Synchronizing Alarms

The SNMP NBI allows the OSS to initiate the synchronization operation to ensure
that the alarm information on the OSS and NCE is consistent.
Function
The UDP-based SNMP protocol cannot guarantee that all alarms are reported to
the OSS. Therefore, the OSS synchronizes alarms to ensure alarm data consistency
with NCE. The OSS can pause the synchronization as required.
When the synchronization starts, the SNMP NBI sends a "start" trap to inform the
OSS that alarm synchronization has started.

iMaster NCE-Fabric
When the synchronization is successfully complete or paused, the SNMP NBI sends
a "stop" trap to inform the OSS that alarm synchronization has stopped.
The following figure shows the alarm synchronization process.
Figure 1-11 Alarm synchronization process
Operation Description
Synchronize 1. The OSS synchronizes alarms.

alarms 2. The SNMP NBI sends a "start" trap to inform the OSS
that alarm synchronization has started.
3. The SNMP NBI sends a result trap containing all valid
alarms in the NCE database.
4. After all valid alarms are reported, the SNMP NBI sends a
"stop" trap to inform the OSS that alarm synchronization
has stopped.

iMaster NCE-Fabric
Operation Description
Stop the alarm 1. The OSS stops the alarm synchronization.

synchronization 2. The SNMP NBI sends a "stop" trap to inform the OSS
that alarm synchronization has stopped.
NOTE
Active alarms (uncleared alarms) are synchronized by default.

For details about the alarm synchronization start trap, see 1.8.2.4.2 Alarm Synchronization
Start Trap.
For details about the alarm synchronization result trap, see Alarm Synchronization Result
Trap.
For details about the alarm synchronization stop trap, see Alarm Synchronization End Trap.
MIB Definition
There are two MIB nodes for alarm synchronization:
hwNmNorthboundEventSynchronizationCommandStart and
hwNmNorthboundEventSynchronizationCommandStop. The former indicates
starting alarm synchronization, whereas the latter indicates stopping alarm
synchronization.
The OIDs are 1.3.6.1.4.1.2011.2.15.1.7.7.4 and 1.3.6.1.4.1.2011.2.15.1.7.7.5.
.hwNetManagement(15).hwNmAgent(1).hwNmNorthboundEvent(7).hwNmNorth
boundEventSynchronization(7).hwNmNorthboundEventSynchronizationCommand
Start(4)
.hwNetManagement(15).hwNmAgent(1).hwNmNorthboundEvent(7).hwNmNorth
boundEventSynchronization(7).hwNmNorthboundEventSynchronizationCommand
Stop(5)

Permission
hwNmNorthboun OCTET STRING read-write Alarm

dEventSynchroni- synchronization is
zationCommandSt started.
art
hwNmNorthboun OCTET STRING read-write Alarm

dEventSynchroni- synchronization is
zationCommandSt stopped.
op

iMaster NCE-Fabric
Setting Method
Start alarm synchronization.
The OSS can set the value of the MIB node to start alarm synchronization within a
specified period. The format is as follows:
IP:port:start time:end time
Stop alarm synchronization.
The OSS can set the value of the MIB node to stop alarm synchronization. The
IP:port
NOTE
● When you set the OID of the MIB node, you must add .0 to the end of the original OID
of the MIB node.
● You do not need to set the start and end time to stop the alarm synchronization.
Table 1-33 Format description - synchronizing alarms
IP IP address used by the OSS. This IP address is the trap receiving

IP address preset when the SNMP NBI is configured.
port Port used by the OSS. This port is the trap receiving port preset
when the SNMP NBI is configured.
start Start and end time for alarm synchronization.

time:endtim The alarms generated within this period are synchronized.
e
NOTE
● If the end time is not set, the current system time of NCE is used as
the end time.
● If the start and end time are not set, all valid alarms are synchronized.
● If the end time is set, the start time is mandatory.
● Both the start and end time indicate the time when alarms are
generated rather than when alarms are reported to NCE.
● The UTC time, local time, and local time with the time zone are not
distinguished.
The start time and end time are in the format of
YYYYMMDDhhmmss.
● YYYY: Four-digit year. The value starts from 1970.
● MM: Two-digit month. The value range is 01 to 12.
● DD: Two-digit date. The value range is 01 to 31.
● hh: Two-digit hour. The value range is 00 to 23.
● mm: Two-digit minutes. The value range is 00 to 59.
● ss: Two-digit seconds. The value range is 00 to 59.

iMaster NCE-Fabric
Sample
Prerequisites
● The IP address of the OSS is set to 10.70.73.97 and the port for receiving
alarms is set to 6666.
● The OSS connects to the SNMP NBI and can receive heartbeats or real-time
alarms.
Purpose
To synchronize alarms that are generated between 2011-03-01 00:00:00 and

2011-03-15 00:00:00.
Table 1-34 Sample parameters - synchronizing alarms
The IP of the upper-layer 10.70.73.97 10.70.73.97

NMS
Receive Trap Port 6666 6666
Start time 2011-03-01 00:00:00 20110301000000
End Time 2011-03-15 00:00:00 20110315000000
Procedure
1. The OSS sets the OID of the

hwNmNorthboundEventSynchronizationCommandStart node to:
1.3.6.1.4.1.2011.2.15.1.7.7.4.0
2. The OSS sets the value of the
hwNmNorthboundEventSynchronizationCommandStart node to:
10.70.73.97:6666:20110301000000:20110315000000
– If set successfully, the SNMP NBI sends a "start" trap to inform the OSS
that alarm synchronization has started.
– The OSS receives alarms (from the NCE database) that generated within
the specified period. The SNMP NBI reports valid alarms to the OSS in the
form of a result trap.
3. (Optional) To stop the synchronization, the OSS sets the
hwNmNorthboundEventSynchronizationCommandStop node to:
10.70.73.97:6666
4. When the synchronization is successfully complete or paused, the SNMP NBI
sends a "stop" trap to inform the OSS that alarm synchronization has
stopped.

iMaster NCE-Fabric
1.8.8.1.4 Acknowledging Alarms

The SNMP NBI allows the OSS to acknowledge alarms on NCE by alarm SN. An
acknowledged alarm is an alarm that has been handled.
Function
The OSS can acknowledge NCE alarms based on the alarm SNs.
The alarm status will change after the alarm is acknowledged. If acknowledged
alarms are specified as the filter criteria, the OSS will receive the information
about state changes along with the alarms.
NOTE
The Acknowledgement User parameter is SNMP Agent User on the NCE client after an
alarm is acknowledged by the OSS through the SNMP NBI.
Alarms with invalid or nonexistent SNs and historical alarms cannot be acknowledged and
the SNs will be returned to the OSS.
MIB Definition
The OID is 1.3.6.1.4.1.2011.2.15.1.3.7.
.hwNetManagement(15).hwNmAgent(1).hwNmFault(3).hwNmAcknowledgeAlarm
s(7)

Permission
hwNmAcknowled OCTET STRING read-write Alarms are

geAlarms acknowledged
based on SNs.
NOTE
The GET operation is not supported on this MIB node.
Setting Method
The OSS can set the value of the MIB node to acknowledge the active alarm on
NCE. The format is as follows:
Serial Number,Serial Number,...

iMaster NCE-Fabric
Table 1-35 Format description - acknowledging alarms

Serial SN of an alarm.
Number,Seri Integer, separated by a comma (,).
al Number,...
The following table lists the status changes when alarms are acknowledged.
Table 1-36 Alarm status - acknowledging alarms

No. Alarm Status Status Change SET Response Failed List
1 Unacknowledge Acknowledged Success Empty

d and and uncleared
uncleared
2 Unacknowledge Acknowledged Success Empty

d and cleared and cleared
3 Acknowledged Acknowledged Success Empty

and uncleared and uncleared
4 Acknowledged None Success Alarm SN

and cleared
NOTE
If you set the lifecycle for acknowledged and cleared alarms and these alarms are not
converted to historical alarms, no data will be returned after you acknowledge these
alarms. The lifecycle specifies the period in which these alarms are saved in the current-
alarm database.
When you set the OID of the MIB node, you must add .0 to the end of the original OID of
the MIB node.
Sample
Prerequisites
The OSS connects to the SNMP NBI and can receive heartbeats or real-time
alarms.
Purpose
To acknowledge the alarm on NCE with the SN of 20,30,10005,18000.

iMaster NCE-Fabric
Table 1-37 Sample parameters - acknowledging alarms
Alarm SN 20,30,10005,18000 20,30,10005,18000
Procedure
1. The OSS sets the OID of the hwNmAcknowledgeAlarms node to:

1.3.6.1.4.1.2011.2.15.1.3.7.0.
2. The OSS sets hwNmAcknowledgeAlarms to:
20,30,10005,18000.
Query the alarm status on the OSS or NCE. The state for alarm 20,30,10005,18000
is Acknowledge, indicating that the alarm is acknowledged successfully. The
Acknowledgement User parameter is SNMP Agent User on the NCE client.
NOTE
If acknowledged alarms are specified as the filter criteria, the OSS will receive the
information about state changes along with the alarms. The alarm time is when the alarm
is acknowledged.
1.8.8.1.5 Unacknowledging Alarms

The SNMP NBI allows the OSS to unacknowledge alarms on NCE by alarm SN.
This function allows you to unacknowledge an acknowledged alarm if necessary.
Function
The OSS can unacknowledge alarms on NCE based on alarm SNs.
The alarm status will change after the alarm is unacknowledged. If

unacknowledged alarms are specified as the filter criteria, the OSS will receive the
information about state changes along with the alarms.
NOTE
The Acknowledgement User parameter is SNMP Agent User on the NCE client after an
alarm is unacknowledged by the OSS through the SNMP NBI.
Alarms with invalid or nonexistent SNs and historical alarms cannot be unacknowledged
and the SNs will be returned to the OSS.
MIB Definition
The OID is 1.3.6.1.4.1.2011.2.15.1.3.8.
.hwNetManagement(15).hwNmAgent(1).hwNmFault(3).hwNmUnAcknowledgeAla
rms(8)

iMaster NCE-Fabric

Permission
hwNmUnAcknowl OCTET STRING read-write Alarms are

edgeAlarms unacknowledged
based on SNs.
NOTE
Setting Method
The OSS can set the value of the MIB node to unacknowledge the active alarm on
NCE. The format is as follows:
Table 1-38 Format description - acknowledging alarms

al Number,...
The following table lists the status changes when alarms are unacknowledged.
Table 1-39 Alarm status - unacknowledging alarms

No. Alarm Status Status Change SET Response Failed List
1 Unacknowledg Unacknowledge Success Empty

ed and d and uncleared
uncleared
2 Unacknowledg Unacknowledge Success Empty

ed and cleared d and cleared
3 Acknowledged Unacknowledge Success Empty

and uncleared d and uncleared
3 Acknowledged None Success Alarm SN

and cleared

iMaster NCE-Fabric
NOTE
converted to historical alarms, no data will be returned after you unacknowledge these
alarms. The lifecycle specifies the period in which these alarms are saved in the current-
alarm database.
the MIB node.
Sample
Prerequisites
alarms.
Purpose
To unacknowledge the alarm on NCE with the SN of 20,30,10005,18000.
Table 1-40 Sample parameters - unacknowledging alarms

Alarm SN 20,30,10005,18000 20,30,10005,18000
Procedure
● The OSS sets the OID of the hwNmUnAcknowledgeAlarms node to:
1.3.6.1.4.1.2011.2.15.1.3.8.0.
● The OSS sets hwNmUnAcknowledgeAlarms to:
20,30,10005,18000.
is Unacknowledge, indicating that the alarm is unacknowledged successfully. The
Acknowledgement User parameter is SNMP Agent User on the NCE client.
NOTE
If unacknowledged alarms are specified as the filter criteria, the OSS will receive the
information about state changes along with the alarms. The alarm time is when the alarm
is generated.
1.8.8.1.6 Clearing Alarms

The SNMP NBI allows the OSS to clear alarms on NCE by alarm SN. Manually
clear the alarm if NCE cannot automatically clear the alarm or this alarm does not
exist on an NE.
Function
The OSS can clear alarms on NCE based on the alarm SNs.

iMaster NCE-Fabric
The alarm status will change after the alarm is cleared. If cleared alarms are
specified as the filter criteria, the OSS will receive the information about state
changes along with the alarms.
NOTE
The Clearance User parameter is SNMP Agent User on the NCE client after an alarm is
cleared by the OSS through the SNMP NBI.
Alarms with invalid or nonexistent SNs and historical alarms cannot be cleared and the SNs
will be returned to the OSS.
MIB Definition
The OID is 1.3.6.1.4.1.2011.2.15.1.3.6.
.hwNetManagement(15).hwNmAgent(1).hwNmFault(3).hwNmClearAlarms(6)

Permission
hwNmClearAlarm OCTET STRING read-write Alarms are

s cleared based on
SNs.
NOTE
Setting Method
The OSS can set the value of the MIB node to clear the active alarm on NCE. The
Table 1-41 Format description - clearing alarms
al Number,...
The following table lists the status changes when alarms are cleared.

iMaster NCE-Fabric
Table 1-42 Alarm status - clearing alarms
No. Alarm Status Status SET Response Failed List

Change
1 Unacknowled Unacknowled Success Empty

ged and ged and
uncleared cleared
2 Unacknowled Unacknowled Success Empty

ged and ged and
cleared cleared
3 Acknowledge Acknowledge Success Empty

d and d and cleared
uncleared
4 Acknowledge None Success Alarm SN

d and cleared
NOTE
converted to historical alarms, no data will be returned after you clear these alarms. The
lifecycle specifies the period in which these alarms are saved in the current-alarm database.
the MIB node.
Sample
Prerequisites
alarms.
Purpose
To clear the alarm on NCE with the SN of 20,30,10005,18000.
Table 1-43 Sample parameters - clearing alarms
Alarm SN 20,30,10005,18000 20,30,10005,18000
Procedure
1. The OSS sets the OID of the hwNmClearAlarms node to:
1.3.6.1.4.1.2011.2.15.1.3.6.0.
2. The OSS sets hwNmClearAlarms to:

iMaster NCE-Fabric
20,30,10005,18000.
is Clear, indicating that the alarm is cleared successfully. The Clearance User
parameter is SNMP Agent User on the NCE client.
NOTE
If a cleared alarm is also an acknowledged one, it becomes a historical alarm.

If cleared alarms are specified as the filter criteria, the OSS will receive the information
about state changes along with the alarms. The alarm time is when the alarm is cleared.
1.8.8.1.7 Reporting Alarm Acknowledgement Status

The SNMP NBI reports the alarm acknowledgement status.
Function
After you configure alarm acknowledgement status reporting through the SNMP
NBI on NCE, the OSS receives alarm acknowledgement status in real time.
MIB Definition
The OID is 1.3.6.1.4.1.2011.2.15.1.7.1.33.
.netManagement(15).nmAgent(1).nmNorthboundEvent(7).hwNmNorthboundEven
tInfo(1).hwNmNorthboundConfirmStatus(33)

Permission
hwNmNorthboun Integer32 read-write ● 1:

dConfirmStatus acknowledged
● 2:
unacknowledg
ed
NOTE
The Get and Set operations are not supported on this MIB node.
Setting Method
For details, see Configuration Operations.
1.8.8.1.8 Reporting Alarm Clearance Status

The SNMP NBI reports the alarm clearance status.

iMaster NCE-Fabric
Function
After you configure alarm clearance status reporting through the SNMP NBI on
NCE, the OSS receives alarm clearance status in real time.
MIB Definition
The OID is 1.3.6.1.4.1.2011.2.15.1.7.1.34.
.netManagement(15).nmAgent(1).nmNorthboundEvent(7).hwNmNorthboundEven
tInfo(1).hwNmNorthboundRestoreStatus(34)

Permission
hwNmNorthboun Integer32 read-write ● 1: cleared

dRestoreStatus ● 2: uncleared
NOTE
The Get and Set operations are not supported on this MIB node.
Setting Method
For details, see Configuration Operations.
1.9 Interface Reference
1.9.1 User Authentication Service

API used by a machine-machine account to obtain a token based on the username
and password.
1.9.1.1 Obtain a Token
Typical Scenarios
A token needs to be obtained using the user name and password when a third-
party system is interconnected and needs to access an open API.
Functions
Allow northbound systems to obtain tokens. By default, an account is locked for
10 minutes when it fails to obtain a token for five consecutive times within 10
minutes. The account policy can be customized based on site requirements.The
interface can process a maximum of 25 requests per second. If there are more

iMaster NCE-Fabric
than 25 requests, the interface will return a message indicating that the system is
busy.
Constraints
N/A.
HTTP Method
POST
URI
/controller/v2/tokens
Request Parameters
Param Mand Type Value Defaul Description Example

eter atory Range t Value
authCr Yes REFER For details, see Parameter for -

edit ENCE Table 1-45. obtaining a
token.
Table 1-45 AuthCreditV2In parameters

userNa No string 1 to - User name. "zhangsan@xx

me 128 x.com"
charac
ters.
passw No passw 5 to - This field may "******"

ord ord 128 contain
charac sensitive or
ters. personal data.
Keep it secure.
User password.
Sample Request
cURL

iMaster NCE-Fabric
curl -k -s -L -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-

Language: en-US' 'https://192.168.1.125:18002/controller/v2/tokens' -d '{
"userName" : "zhangsan@xxx.com",
"password" : "******"
}'
HTTP
POST /controller/v2/tokens HTTP/1.1
Host: 192.168.1.125:18002
Accept-Language: en-US
{
"userName" : "zhangsan@xxx.com",
"password" : "******"
}
Response Parameters
Response status code 200: OK
Table 1-46 AuthTokenV2Out parameters
Param Type Value Range Defaul Description Example

eter t Value
data REFER For details, see Table - -

ENCE 1-47.
errcod string 0 to 128 - Error code. "0x11aa22bb"

e characters.
errmsg string 0 to 128 - Error message. "The userName

characters. or password is
incorrect."
Table 1-47 data parameters

eter t Value
token_i string 0 to 1024 - Token ID. "xxxxxxxxxxxxx

d characters. xxxxxxxxxxxxxx
xxxxxx"
expired string 0 to 128 - Token timeout "2018-10-30

Date characters. time, in the 10:09:23"
format yyyy-
MM-dd
HH:mm:ss.
Response status code 401: Unauthorized.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
{
"data" : {
"token_id" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"expiredDate" : "2018-10-30 10:09:23"
},
"errcode" : "0x11aa22bb",
"errmsg" : "The userName or password is incorrect."
}

HTTP/1.1 401 Unauthorized
Date: Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
1.9.1.2 Delete a Token
Typical Scenarios
A token used during interconnection with a third-party system needs to be deleted
if it is no longer used.
Functions
Delete a token.
Constraints
N/A.
HTTP Method
DELETE
URI
/controller/v2/tokens

iMaster NCE-Fabric
Request Parameters

revoke Yes REFER For details, see Parameter for -

Token ENCE Table 1-49. releasing a
token.
Table 1-49 revokeTokenV2In parameters

token No string 0 to - This field may "xxxxxxxxxxxxx

1024 contain xxxxxxxxxxxxxx
charac sensitive or xxxxxx"
Keep it secure.
Token ID.
Sample Request
cURL
curl -k -s -L -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-
Language: en-US' 'https://192.168.1.125:18002/controller/v2/tokens' -d '{
"token" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'
HTTP
DELETE /controller/v2/tokens HTTP/1.1
Host: 192.168.1.125:18002
{
"token" : "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
Response Parameters

iMaster NCE-Fabric
Table 1-50 revokeTokenV2Out parameters

eter t Value
errcod string 0 to 128 - Error code. "0x22aa33bb"

e characters.
errmsg string 0 to 128 - Error message. "The

characters. parameter is
invalid."

Sample Response
HTTP/1.1 200 OK
Date: Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
{
"errcode" : "0x22aa33bb",
"errmsg" : "The parameter is invalid."
}

Date: Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
1.9.1.3 Change Personal Password
Typical Scenarios
The password of the northbound operator needs to be changed when a third-
party system is interconnected and the user password becomes invalid. Only the
password of the current user can be changed. When this API is invoked, the token
value that identifies the user must be transferred in the HTTP context header.
Functions
Change the password.
Constraints
N/A.

iMaster NCE-Fabric
HTTP Method
POST
URI
/restconf/operations/huawei-ac-access-token:update-password
Request Parameters
Table 1-51 header parameters

x- Yes string - - X-Uni-Session- -

access- Id
token

update Yes REFER For details, see Parameter for -

Passw ENCE Table 1-53. updating a
ord password.
Table 1-53 RestconfUpdatePasswordV2In parameters

input No REFER For details, see - -

ENCE Table 1-54.

iMaster NCE-Fabric
Table 1-54 input parameters

oldpw No string 5 to - This field may "******"

d 128 contain
charac sensitive or
Keep it secure.
Old password.
newpw No string 5 to - This field may "******"

d 128 contain
charac sensitive or
Keep it secure.
New password.
Sample Request
cURL
Language: en-US' -H 'x-access-token: ' 'https://192.168.1.125:18002/restconf/operations/huawei-ac-access-
token:update-password' -d '{
"input" : {
"oldpwd" : "******",
"newpwd" : "******"
}
}'
HTTP
POST /restconf/operations/huawei-ac-access-token:update-password HTTP/1.1
Host: 192.168.1.125:18002
x-access-token:
{
"input" : {
"oldpwd" : "******",
"newpwd" : "******"
}
}
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250

Date: Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
1.9.1.4 Authenticate a User
Functions
This interface is used for third-party user authentication and login.
SLA Item Description
Request success rate ≥ 99%
Availability Tier2
Data consistency Eventually consistent, inconsistent

duration < 1 minute
Throughput 20 tps
TP50 request delay 20 ms
TP99.9 request delay 200 ms
Precautions
When accessing the application interface, set the HTTP header to the session
obtained after the northbound login. The key is X-Auth-Token and the value is the
session value, for example, X-Auth-Token:xxx.
HTTP Method
PUT
URI
/rest/plat/smapp/v1/sessions
Path parameters
None

iMaster NCE-Fabric
Query parameters
None
Request
● Header parameters
See the sample request.
● Body parameters
Paramete Mandato Type Value Description

r ry Range
grantType Yes strin None Indicates the grant type.

g
userName Yes strin None Indicates the username of a

g third-party system access
user.
value Yes pass None Indicates the password.

word
organizati No strin None Indicates the orgname of a

onName g third-party system access
user.
● Sample request
PUT /rest/plat/smapp/v1/sessions HTTP/1.1
Accept:application/json
Content-Type:application/json;charset=UTF-8
{
"grantType": "password",
"userName": "XXX",
"value": "***"
}
Response
● Response parameters
– Response status code 200:
The string is returned.
● Sample response
HTTP/1.1 200 OK
Content-Type:application/json
{
"accessSession": "x-yyyyyyy",
"roaRand": "xxxxxxx",
"expires": 1800,
"additionalInfo": {
"expires":"2",
"passwdStatus":"expiring"
}
}

iMaster NCE-Fabric
Status Codes
Status Code Description
200 The request is successful.
400 Incorrect username or password.

Parameter error.
The number of incorrect password
attempts reaches the maximum.
The user is locked.
The password has expired.
The centralized authentication server
fails to be connected.
In centralized authentication mode,
the database or service is abnormal.
the unauthorized user is not allowed
to log in. Contact the administrator.
The number of login attempts has
reached the upper limit. Contact the
administrator.
403 The login is restricted. Contact the

administrator. For example:account
suspension.
Operation Severity
Minor
1.9.1.5 Log Out a Session
Functions
This interface is used to log out the current third-party session or a common
session.
Availability Tier2

duration < 1 minute
Throughput 20 tps

iMaster NCE-Fabric
Precautions
None
HTTP Method
DELETE
URI
/rest/plat/smapp/v1/sessions
Path parameters
None
Query parameters
None
Request
r ry Range
Cookie No strin None Indicates the accessSession

g value returned in the process
of invoking an
authentication interface. The
format is accessSession=x-
yyyyyyy. Note: If this
interface is invoked by
OpenAPI, the accessSession
validity is not checked. If this
interface is invoked by a
browser, X-Auth-Token is not
required.
roaRand No strin None Indicates the roaRand value

g returned in the process of
invoking an authentication
interface.

iMaster NCE-Fabric

r ry Range
X-Auth- No strin None Indicates the accessSession

Token g value returned in the process
of invoking an
authentication interface.
Note: If this interface is
invoked by OpenAPI, either
Cookie or X-Auth-Token, or
both, must be transferred.
● Body parameters
None
● Sample request
DELETE /rest/plat/smapp/v1/sessions HTTP/1.1

Cookie:accessSession=x-yyyyyyy
roaRand:xxxxxxx
DELETE /rest/plat/smapp/v1/sessions HTTP/1.1

X-Auth-Token:x-yyyyyyy
Response
● Sample response
HTTP/1.1 200 OK
Status Codes
200 The request has been successfully

delivered.
406 Invalid parameter.
Operation Severity
Minor

iMaster NCE-Fabric
1.9.1.6 Authenticate a User V1 (Compatible with Earlier Versions)
Functions
Availability Tier2

duration < 1 minute
Throughput 20 tps
Precautions
session value, for example, X-Auth-Token:xxx.
HTTP Method
PUT
URI
/rest/plat/smapp/v1/oauth/token
Path parameters
None
Query parameters
None
Request
● Body parameters

iMaster NCE-Fabric

r ry Range
grantType Yes strin None Indicates the grant type.

g
userName Yes strin None Indicates the username of a

g third-party system access
user.
value Yes pass None Indicates the password.

word
organizati No strin None Indicates the orgname of a

onName g third-party system access
user.
● Sample request
PUT /rest/plat/smapp/v1/oauth/token HTTP/1.1
{
"grantType": "password",
"userName": "XXX",
"value": "***"
}
Response
● Sample response
HTTP/1.1 200 OK
{
"accessSession": "x-yyyyyyy",
"roaRand": "xxxxxxx",
"expires": 1800,
"additionalInfo": {
"expires":"2",
"passwdStatus":"expiring"
}
}

iMaster NCE-Fabric
Status Codes
200 The request is successful. The meaning

of each field in the returned string is
as follows:
● accessSession After a user logs in to
the NBI system and accesses the
application interface, the user sets
the session to the HTTP cookie. The
key is accessSession.
● roaRand When a user accesses a
non-GET ROA interface, the
roaRand needs to be added to the
request header. The key is roarand.
● expires The session becomes invalid
when it does not respond within
this period.
● In additionalInfo, expires represents
the remaining validity days of the
password. passwdStatus represents
the password status, and the value
expiring indicates that the password
is about to expire.

Parameter error.
The number of incorrect password
The user is locked.
The centralized authentication server
fails to be connected.
the database or service is abnormal.
the unauthorized user is not allowed
administrator.

suspension.

iMaster NCE-Fabric
Operation Severity
Minor
1.9.1.7 Add an SSO Server Whitelist
Functions
Add an SSO server whitelist.
Availability Tier2

duration < 1 minute
Throughput 20 tps
Precautions
Users attached to the SMManagers role can call this interface. When accessing the
application interface, set the HTTP header to the session obtained after the
northbound login. The key is X-Auth-Token and the value is the session value, for
example, X-Auth-Token:xxx.
HTTP Method
POST
URI
/rest/plat/smapp/v1/sso-server
Path parameters
None
Query parameters
None
Request
● Body parameters

iMaster NCE-Fabric

r ry Range
id No strin None Whitelist ID.

g
descriptio No strin None Whitelist description, which

n g contains a maximum of 127
characters.
host No strin None Whitelist address, which can

g be a domain name, IPv4
address, or IPv6 address. This
parameter is mandatory
when the whitelist address is
a single IP address and its
type is a domain name.
startip No strin None Start IP address. This

g parameter is mandatory
when the whitelist address
type is a range.
endip No strin None End IP address. This

type is a range.
createDat No strin None Creation time. This

eTime g parameter is returned only
for query and is not required
for creation.
type Yes int32 None Whitelist address type. The

value 0 indicates an IPv4
address, 1 indicates an IPv6
address, 2 indicates a
domain name, 3 indicates an
IPv4 address range, and 4
indicates an IPv6 address
range.
● Sample request
POST /rest/plat/smapp/v1/sso-server HTTP/1.1
{
"description":"fdaf",
"host":"***.***.***",
"startip":"",
"endip":"",
"type":2
}

iMaster NCE-Fabric
Response
● Sample response
HTTP/1.1 200 OK
Content-Type:text/plain
Status Codes
406 Parameter error.

The format of the entered trusted
address is incorrect.
400 The whitelist to be added already

exists.
403 Authentication failed
Operation Severity
Minor
1.9.1.8 Query SSO Server Whitelists
Functions
Query SSO server whitelists.
Availability Tier2

duration < 1 minute
Throughput 20 tps
Precautions

iMaster NCE-Fabric
example, X-Auth-Token:xxx.
HTTP Method
GET
URI
Path parameters
None
Query parameters
Parameter Mandator Type Value Description

y Range
ssoServerA Yes string None Query the SSO server address.

ddress If the value of SSO server
address has a range, you need
to enter a start IP address and
an end IP address, for
example,
10.111.111.111~10.222.222.22
2.
Request
● Body parameters
None
● Sample request
GET /rest/plat/smapp/v1/sso-server?ssoServerAddress=10.111.111.111~10.222.222.222
HTTP/1.1
Response
● Sample response
HTTP/1.1 200 OK
{
"id":1,
"description":"",

iMaster NCE-Fabric
"host":null,
"startip":"10.111.111.111",
"endip":"10.222.222.222",
"createDateTime":null,
"type":3
}
Status Codes
200 The request is successful. If the queried

SSO Server exists, the SSO Server
information is returned. If the queried
SSO Server does not exist, an empty
string is returned.
Operation Severity
Minor
1.9.1.9 Delete SSO Server Whitelists in Batches
Functions
Delete SSO server whitelists in batches.
Availability Tier2

duration < 1 minute
Throughput 20 tps
Precautions
example, X-Auth-Token:xxx. All corresponding IDs of the SSO server whitelists to

iMaster NCE-Fabric
be deleted must exist. Otherwise, the interface fails to be called and the error
code 400 is returned.
HTTP Method
DELETE
URI
Path parameters
None
Query parameters

y Range
ids Yes string None Whitelist IDs.
Request
● Body parameters
None
● Sample request
DELETE /rest/plat/smapp/v1/sso-server?ids=[1,2,3,4] HTTP/1.1
Accept:text/plain
Response
● Sample response
HTTP/1.1 200 OK
Status Codes
400 Some deleted SSO server whitelists do

not exist.

iMaster NCE-Fabric
Operation Severity
Minor
1.9.1.10 Modify an SSO Server Whitelist
Functions
Modify the SSO server whitelist of a specified ID.
Availability Tier2

duration < 1 minute
Throughput 20 tps
Precautions
example, X-Auth-Token:xxx. Any modified SSO server whitelist cannot be identical
to an existing one. Otherwise, the interface fails to be called and the error code
400 is returned.
HTTP Method
PUT
URI
/rest/plat/smapp/v1/sso-server/{id}
Path parameters

y Range
id Yes string None Whitelist ID.
Query parameters
None

iMaster NCE-Fabric
Request
● Body parameters
r ry Range
id No strin None Whitelist ID.

g
descriptio No strin None Whitelist description, which

n g contains a maximum of 127
characters.
host No strin None Whitelist address, which can

g be a domain name, IPv4
address, or IPv6 address. This
parameter is mandatory
when the whitelist address is
a single IP address and its
type is a domain name.
startip No strin None Start IP address. This

type is a range.
endip No strin None End IP address. This

type is a range.
createDat No strin None Creation time. This

eTime g parameter is returned only
for query and is not required
for creation.
type Yes int32 None Whitelist address type. The

value 0 indicates an IPv4
address, 1 indicates an IPv6
address, 2 indicates a
domain name, 3 indicates an
IPv4 address range, and 4
indicates an IPv6 address
range.
● Sample request
PUT /rest/plat/smapp/v1/sso-server/1 HTTP/1.1
{
"description":"testDescription",
"host":"X.X.X.X",
"startip":"",
"endip":"",

iMaster NCE-Fabric
"type":0
}
Response
● Sample response
HTTP/1.1 200 OK
Content-Type:text/plain
Status Codes
400 The modified SSO server whitelist is

identical to an existing one.
Operation Severity
Minor
1.9.1.11 Authenticate a User V2 (Compatible with Earlier Versions)
Functions
Availability Tier2

duration < 1 minute
Throughput 20 tps
Precautions

iMaster NCE-Fabric
session value, for example, X-Auth-Token:xxx. Content-Type of this interface can be

application/json;charset=UTF-8 or application/x-www-form-
urlencoded;charset=UTF-8.
HTTP Method
PUT
URI
/rest/openapi/sm/session
Path parameters
None
Query parameters
None
Request
● Body parameters
r ry Range
userid Yes strin None Indicates the username.

g
value Yes pass None Indicates the user password

word of a third-party system
access user.
ipaddr No strin None Indicates the IP address.

g Note: The IP address
returned for the request is
used in priority. This IP
address is a reserved IP
address and used only when
no IP address is returned for
the request.
● Sample request
PUT /rest/openapi/sm/session HTTP/1.1
{
"userid": "XXX",
"value": "XXX",
"ipaddr": "127.0.0.1"
}
PUT /rest/openapi/sm/session HTTP/1.1

iMaster NCE-Fabric
Accept:application/x-www-form-urlencoded
Content-Type:application/x-www-form-urlencoded;charset=UTF-8
userid=XXX&value=XXX&ipaddr=127.0.0.1
Response
The OpenAPIResult object is returned.
Attributes of the OpenAPIResult object
Paramet Mandato Type Value Description
er ry Range
code Yes int32 None Indicates the response

code of the operation. The
● 0: Successful
● Other value: Failed
data No strin None Returned session

g
descripti No strin None Indicates the description of

on g the returned information
● Sample response
HTTP/1.1 200 OK
{
"code" : 0,
"data" : "xxxxxxxxxxxxxxxxxxxxxxxx",
"description" : "Operation success."
}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "Login failure. Incorrect user name or password."
}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "Login failed due to incorrect user name or password. The user account
has been locked."
}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "Password has expired."
}
HTTP/1.1 200 OK
{
"code" : 1,

iMaster NCE-Fabric
"description" : "Failed to connect to the centralized authentication server."

}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "The service is not started or the database fails to be connected.
Contact the administrator to resolve the problem."
}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "An unauthorized user cannot log in. Contact the system administrator."
}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "Login not allowed. Contact the administrator."
}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "Internal service error. Contact the administrator to resolve the
problem."
}
Status Codes
200 The request is successful or failed.
Operation Severity
Minor
1.9.1.12 Log Out a Session V2 (Compatible with Earlier Versions)
Functions
This interface is used to log out the current third-party session or a common
session.
Availability Tier2

duration < 1 minute

iMaster NCE-Fabric
Throughput 20 tps
Precautions
None
HTTP Method
DELETE
URI
/rest/openapi/sm/session
Path parameters
None
Query parameters
None
Request
r ry Range
openid No strin None Indicates the session ID of

g the user who needs to be
logged out.
Note: This parameter is
obtained by invoking the
OpenAPI authentication
interface.
● Body parameters

iMaster NCE-Fabric

r ry Range
openid No strin None Indicates the session ID of

g the user who needs to be
logged out.
Note: This parameter is
obtained by invoking the
OpenAPI authentication
interface. If openid is
available both in the request
header and in the parameter
list, openid in the request
header takes effect.
● Sample request
DELETE /rest/openapi/sm/session HTTP/1.1
openid:r-xxxxxxxxxxxxxxxxx
DELETE /rest/openapi/sm/session HTTP/1.1

{
"openid": "r-xxxxxxxxxxxxxxxxx"
}
Response
The OpenAPIResult object is returned.
Attributes of the OpenAPIResult object
er ry Range
code Yes int32 None Indicates the response

code of the operation. The
● 0: Successful
● Other value: Failed
data No strin None Returned session

g
descripti No strin None Indicates the description of

on g the returned information
● Sample response
HTTP/1.1 200 OK

iMaster NCE-Fabric
{
"code" : 0,
"description" : "Operation success."
}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "openID is wrong."
}
HTTP/1.1 200 OK
{
"code" : 1,
"description" : "failed. user has logout."
}
Status Codes
200 The request is successful or failed.
Operation Severity
Minor
1.9.1.13 Authenticate a Common User or a Remote User
Functions
This interface authenticates the login of a common user or a remote user.
Availability Tier2

duration < 1 minute
Throughput 20 tps
Precautions
This interface must be accessed through HTTPS.

iMaster NCE-Fabric
HTTP Method
PUT
URI
/rest/plat/uam/v1/auth/uniauth
Path parameters
None
Query parameters
None
Request
● Body parameters

r ry Range
terminal Yes strin None Indicates the IP address of a

g terminal.
userName Yes strin Default: "" Indicates the username.

g
userEmail No strin Default: "" Indicates the user email , it

g is used when login by email.
userPhon No strin Default: "" Indicates the user phone

e g number, it is used when
login by phone number.
value Yes pass None Indicates the password used

word by users for login.
sessionInv No boole true,false Indicates whether a session

alid an Default: is invalid. This parameter is
false required for generating a
session and not required if
only passwords are verified.
true: The user logins are not
limited and the number of
user logins is not consumed.
false: The session is valid.
User logins are limited by
the values of Max. online
sessions and Allowed logins.
organizati No strin None Indicates the tenant name.

onName g

iMaster NCE-Fabric

r ry Range
attributes No Map None Indicates extended

<obje attributes.
ct,
strin
g>
● Sample request
PUT /rest/plat/uam/v1/auth/uniauth HTTP/1.1
X-Auth-Token: x-hesbaoru3sj********bznw7x7xfy2kaptjju
{
"terminal": "127.0.0.1",
"userName": "XXX",
"value": "***",
"sessionInvalid": "true"
}
Response
The UniUserInfo object is returned.
Attributes of the UniUserInfo object
er ry Range
userId No int32 None Indicates the user ID.
userNam No strin None Indicates the username.

e g
type No int32 None Indicates the user type.
enableIdl No bool true,false Specifies whether to

eTime ean Default: enable the idle timeout
false period.
idleTime No int32 Default: 0 Indicates the idle timeout

period.
roleIds No List< None Indicates the list of IDs of

int32 roles to which users
> belong.
roleNam No List< None Indicates the list of names

es strin of roles to which users
g> belong.

iMaster NCE-Fabric

er ry Range
region No Regi None Indicates the region to

on which a user belongs.
obje
ct
resource No Map None Indicates the resource

Groups <obj groups bound to a user.
ect,
List<
User
Reso
urce
Grou
p>>
permissio No Map None This is a discarded field.

ns <obj
ect,
List<
strin
g>>
callBack No CallB None Indicates an object

Url ackU containing callback
rl functions that are used
obje when roles or resource
ct groups do not meet
requirements.
domain No Regi None This is a reserved field.

on
obje
ct
privateRo No int32 None Indicates the private role

leId ID to which users belong.
organizat No strin None Indicates the organization

ionName g name.

ionId g ID.
refreshTo No strin None Indicates the refresh token.

ken g
Attributes of the Region object

iMaster NCE-Fabric

er ry Range
id No strin None Indicates the region ID.

g
name No strin None Indicates the region name.

g
descripti No strin None Indicates the region

on g description.
domain No int32 None Indicates the domain to

which the region belongs.
mgrRoleI No int32 None Indicates the role ID of the

d region administrator.
mgrUserI No int32 None Indicates the user ID of the

d region administrator.

ionId g ID.
parentId No strin None Indicates the parent region

g ID.
isParent No bool true,false Indicates whether has child

ean region.
maxUser No int32 None Total number of users that

Count can be created in the
current region and its
lower-level regions. This
parameter is used only in
NCE-E and is mandatory.
maxRegi No int32 None Total number of regions

onCount that can be created in the
current region and its
lower-level regions. This
parameter is used only in
NCE-E and is mandatory.
currentU No int32 None Total number of existing

serCount users in the current region
and its lower-level regions.
This parameter is used
only in NCE-E.
currentR No int32 None Total number of existing

egionCou regions in the current
nt region and its lower-level
regions. This parameter is
used only in NCE-E.

iMaster NCE-Fabric

er ry Range
path No strin None String of all parent region

g IDs separated by vertical
lines (|).
extend1 No strin None Indicates the first extend

g field.
extend2 No strin None Indicates the second

g extend field.
Attributes of the CallBackUrl object

er ry Range
roleCallB No strin None Indicates the callback URL

ack g used for verifying roles.
resource No strin None Indicates the callback URL

CallBack g used for verifying resource
groups.
permissio No strin None This is a discarded field.

nCallBac g
k
● Sample response
HTTP/1.1 200 OK
{
"userId": 198245,
"userName": "user007",
"type": 0,
"enableIdleTime": true,
"idleTime": 600000,
"roleIds": [1],
"roleNames": ["Administrators"],
"region": {
"id": "global",
"name": "global",
"description": null,
"domain": 0,
"mgrRoleId": 0
},
"resourceGroups": {
"1": [{
"source": null,
"groupId": "2",
"tag": null
}
]
},
"permissions": {},

iMaster NCE-Fabric
"callBackUrl": {
"roleCallBack": "/rest/plat/xxx/xxx",
"resourceCallBack": "/rest/plat/xxx/xxx",
"permissionCallBack": ""
},
"domain": {
"id": "0",
"name": "global",
"description": null,
"domain": 0,
"mgrRoleId": 0
}
}
Status Codes
200 Authenticated user information is

obtained.

Parameter error.
The user is locked because the number
of incorrect password attempts reaches
the maximum.
The IP address is locked because the
number of the incorrect password
The initial password is not changed.
The password is about to expire.
The unauthorized user is not allowed
administrator.

suspension.
406 Invalid parameter.
Operation Severity
Minor
1.9.2 ZTP

iMaster NCE-Fabric
1.9.2.1 ZTP Region Management

ZTP region management APIs for adding, deleting, modifying, and querying
regions.
1.9.2.1.1 Query Global Configurations
Typical Scenarios
The global configuration needs to be queried.
Functions
Query global configurations.
Constraints
User role: northbound operator.
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/regions/global
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/regions/global HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
rwld6ng9vy2rg96llg85sbdisbmrfw1gdfamaoepoahcaq2nliams8s8epapiofx2r5druhi5g7wmmjzc5btftlduo7w88
bybuqp7xmlup9htd5gpg4bmmrufvnt4aan
Response Parameters
Table 1-55 QueryRegionGlobalDto parameters

eter t Value
snmpA string 1 to 32 - SNMP account. "huawei"

ccount characters.

iMaster NCE-Fabric

eter t Value
authPr string 4 to 8 - Authentication "HMAC_SHA"

otocol characters. protocol.
authP string 8 to 255 - This field may -

WDInf characters. contain
o sensitive or
personal data.
Keep it secure.
Authentication
password.
encryp string 4 to 7 - Encryption "AES_128"

tAlgori characters. algorithm.
thm
encryp string 8 to 255 - This field may -

tPWDI characters. contain
nfo sensitive or
personal data.
Keep it secure.
Encryption
password.
snmpP int32 [1-65535] 0 SNMP port 161

ort number.
timeou int32 [3000-2147483 0 Timeout 4000

t 647] interval.
repetiti int32 [0-255] 0 Number of 3

ons repetitions.
netcon string 1 to 32 - NETCONF "huawei"

fAccou characters. account.
nt
netcon string 8 to 255 - This field may -

fPWDI characters. contain
nfo sensitive or
personal data.
Keep it secure.
NETCONF
password.
netcon int32 [1-65535] 0 NETCONF port 22

fPort number.

iMaster NCE-Fabric
Response status code 400: Response status code 400: Bad request. For example,
the parameter type or value range is incorrect.
Response status code 500: Response status code 500: Internal server error.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"snmpAccount" : "huawei",
"authProtocol" : "HMAC_SHA",
"encryptAlgorithm" : "AES_128",
"snmpPort" : 161,
"timeout" : 4000,
"repetitions" : 3,
"netconfAccount" : "huawei",
"netconfPort" : 22
}
HTTP/1.1 400 Bad Request
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
HTTP/1.1 500 Internal Server Error
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.1.2 Update Global Configurations
Typical Scenarios
The global configuration needs to be queried.
Functions
Update global configurations.
Constraints

iMaster NCE-Fabric
HTTP Method
PUT
URI
/sdn/acdcn/v3/underlay/ztp/regions/global
Request Parameters

body Yes REFER For details, see Parameters for -

ENCE Table 1-57. updating
global
configurations.
Table 1-57 RegionGlobalDto parameters

snmpA Yes string 1 to 32 - SNMP account. "huawei"

ccount charac
ters.
authPr Yes string 4 to 8 - Authentication "HMAC_SHA"

otocol charac protocol.
ters.
authP Yes string 8 to - This field may "********"

WDInf 255 contain
o charac sensitive or
Keep it secure.
Authentication
password.
encryp Yes string 4 to 7 - Encryption "AES_128"

tAlgori charac algorithm.
thm ters.

iMaster NCE-Fabric

encryp Yes string 8 to - This field may "********"

tPWDI 255 contain
nfo charac sensitive or
Keep it secure.
Encryption
password.
snmpP Yes int32 [1-655 0 SNMP port 161

ort 35] number.
timeou Yes int32 [3000- 0 Timeout 4000

t 21474 interval.
83647]
repetiti Yes int32 [0-255 0 Number of 3

ons ] repetitions.
netcon Yes string 1 to 32 - NETCONF "huawei"

fAccou charac account.
nt ters.
netcon Yes string 8 to - This field may "********"

fPWDI 255 contain
nfo charac sensitive or
Keep it secure.
NETCONF
password.
netcon Yes int32 [1-655 0 NETCONF port 22

fPort 35] number.
Sample Request
HTTP
PUT /sdn/acdcn/v3/underlay/ztp/regions/global HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"snmpAccount" : "huawei",
"authProtocol" : "HMAC_SHA",
"authPWDInfo" : "********",
"encryptAlgorithm" : "AES_128",
"encryptPWDInfo" : "********",
"snmpPort" : 161,
"timeout" : 4000,

iMaster NCE-Fabric
"repetitions" : 3,
"netconfAccount" : "huawei",
"netconfPWDInfo" : "********",
"netconfPort" : 22
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.1.3 Query Detailed Region Information by Region ID
Typical Scenarios
Detailed region information needs to be queried.
Functions
Query detailed region information by region ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/regions/info
Table 1-58 query parameters

regioni Yes string 1 to 36 - Region ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/regions/info?regionid=DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-59 RegionDto parameters

eter t Value
regionI string 0 to 36 - Region ID. "DBB702C3-77

d characters. 19-4FE6-
A5AD-3A9C9E2
65309"
region string 1 to 32 - Region name. "Region One"

Name characters.

iMaster NCE-Fabric

eter t Value
deploy string 7 to 16 - Deployment "IN_BAND"

Mode characters. mode.
relyLld boolea - - Whether to use true

p n LLDP relay.
precise boolea - - Whether to false

Plan n perform
refined
planning.
manag string 0 to 64 - Management "vpn"

eVpn characters. VPN.
fabricI string 0 to 36 - Fabric ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
fabric string 0 to 128 - Fabric name. "Fabric One"

Name characters.
ftpIp string 0 to 15 - FTP address. "192.168.1.1"

characters.
ftpPort int32 [0-65535] 0 FTP port 22

number.
ftpAcc string 0 to 32 - FTP account. "admin"

ount characters.
ftpPW string 0 to 256 - This field may "********"

DInfo characters. contain
sensitive or
personal data.
Keep it secure.
FTP password.
ftpMer boolea - - Whether to false

ge n enable FTP
backup.
ftpIpv6 string 0 to 15 - IPv6 address of "fc00::/7"

characters. the FTP server.
ftpPort int32 [0-65535] 0 IPv6 port 22

v6 number of the
FTP server.

iMaster NCE-Fabric

eter t Value
ftpAcc string 0 to 32 - IPv6 account of "admin"

ountv6 characters. the FTP server.
ftpPW string 0 to 256 - This field may "******"

DInfov characters. contain
6 sensitive or
personal data.
Keep it secure.
IPv6 password
of the FTP
server.
backup string 0 to 15 - IP address for "10.0.0.0"

FtpIp characters. FTP backup.
backup int32 [0-65535] 0 Port number 22

FtpPor for FTP backup.
t
backup string 0 to 32 - Account for "admin"

FtpAcc characters. FTP backup.
ount
backup string 0 to 32 - This field may "******"

FtpPW characters. contain
DInfo sensitive or
personal data.
Keep it secure.
Password for
FTP backup.
usedSl boolea - - Whether the false

aveBac n backup FTP
kupFtp server is used.
slaveB string 0 to 15 - IP address of "10.2.3.4"

ackupF characters. the backup FTP
tpIp server. The
value contains
0 to 15
characters.
slaveB int32 [0-65535] 0 Port number of 22

ackupF the backup FTP
tpPort server. The
value is in the
range from 0
to 65535.

iMaster NCE-Fabric

eter t Value
slaveB string 0 to 32 - Backup FTP "admin"

ackupF characters. account. The
tpAcco value contains
unt 0 to 32
characters.
slaveB string 0 to 32 - This field may "******"

ackupF characters. contain
tpPWD sensitive or
Info personal data.
Keep it secure.
Password for
logging in to
the backup FTP
server. The
value contains
0 to 32
characters.
dhcpIp string 0 to 15 - IP address of "10.0.0.0"

characters. the DHCP
server. The
value is in the
range from 0
to 15.
region string 0 to 128 - Region "memo"

Memo characters. remarks.
region ARRAY For details, see Table Extended -

Extend _REFER 1-60. region
edList ENCE information.
Table 1-60 RegionExtendedDto parameters

eter t Value
extAttr string 1 to 256 - Extended "DBB702C3-77

Id characters. attribute value. 19-4FE6-
A5AD-3A9C9E2
65309"
extAttr string 1 to 256 - Extended "A-1"

Name characters. attribute name.

iMaster NCE-Fabric

eter t Value
extAttr string 1 to 256 - Extended "123"

Value characters. attribute ID.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"regionId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"regionName" : "Region One",
"deployMode" : "IN_BAND",
"relyLldp" : true,
"precisePlan" : false,
"manageVpn" : "vpn",
"fabricId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fabricName" : "Fabric One",
"ftpIp" : "192.168.1.1",
"ftpPort" : 22,
"ftpAccount" : "admin",
"ftpPWDInfo" : "********",
"ftpMerge" : false,
"ftpIpv6" : "fc00::/7",
"ftpPortv6" : 22,
"ftpAccountv6" : "admin",
"ftpPWDInfov6" : "******",
"backupFtpIp" : "10.0.0.0",
"backupFtpPort" : 22,
"backupFtpAccount" : "admin",
"backupFtpPWDInfo" : "******",
"usedSlaveBackupFtp" : false,
"slaveBackupFtpIp" : "10.2.3.4",
"slaveBackupFtpPort" : 22,
"slaveBackupFtpAccount" : "admin",
"slaveBackupFtpPWDInfo" : "******",
"dhcpIp" : "10.0.0.0",
"regionMemo" : "memo",
"regionExtendedList" : [
{
"extAttrId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"extAttrName" : "A-1",
"extAttrValue" : "123"
}
]
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.1.4 Query Basic Region Information
Typical Scenarios
Basic region information needs to be queried.
Functions
Query basic region information based on the pagination information and keyword.
Constraints
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/regions/list

limit Yes string 1 to 10 - Maximum "10"

charac number of
ters. records on a
page.
offset Yes string 1 to 10 - Start location. "1"

charac
ters.

iMaster NCE-Fabric

keywor No string 1 to 32 - Keyword. "region1"

d charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/regions/list?limit=10&offset=1&keyword=region1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-62 RegionListDto parameters

eter t Value
pageIn int32 [1-2147483647 0 Page index. 1

dex ]
pageSi int32 [1-2147483647 0 Page size. 10

ze ]
totalRe int32 [1-2147483647 0 Total number 100

cords ] of records.
data ARRAY For details, see Table Region data -

_REFER 1-59. list.
ENCE

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"pageIndex" : 1,
"pageSize" : 10,
"totalRecords" : 100,
"data" : [
{
"relyLldp" : true,
"ftpIp" : "192.168.1.1",
"ftpPort" : 22,
"ftpPWDInfo" : "********",
"ftpMerge" : false,
"ftpIpv6" : "fc00::/7",
"ftpPortv6" : 22,
"dhcpIp" : "10.0.0.0",
{
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.2.1.5 Change the Password of a File Server
Typical Scenarios
The password of a file server in a region needs to be queried.
Functions
Change the password of the file server in a region.
Constraints
HTTP Method
PUT
URI
/sdn/acdcn/v3/underlay/ztp/regions/password
Request Parameters


ENCE Table 1-64. changing a file
server
password.
Table 1-64 ModifyPasswordDto parameters

regionI Yes string 1 to 36 - Region ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

type Yes string 0 to 64 - Type of the "ftp"

charac password to be
ters. changed. The
value contains
0 to 64
characters.
oldPW Yes string 0 to 32 - This field may "******"

DInfo charac contain
ters. sensitive or
personal data.
Keep it secure.
Old password.
newP Yes string 0 to 32 - This field may "********"

WDInf charac contain
o ters. sensitive or
personal data.
Keep it secure.
New password.
Sample Request
HTTP
PUT /sdn/acdcn/v3/underlay/ztp/regions/password HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"type" : "ftp",
"oldPWDInfo" : "******",
"newPWDInfo" : "********"
}
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.1.6 Create a Region
Typical Scenarios
A region needs to be created.
Functions
Create a region based on related information.
Constraints
HTTP Method
POST
URI
/sdn/acdcn/v3/underlay/ztp/regions/region

iMaster NCE-Fabric
Request Parameters


ENCE Table 1-66. creating a
regional.
Table 1-66 RegionDto parameters

regionI No string 0 to 36 - Region ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
region Yes string 1 to 32 - Region name. "Region One"

Name charac
ters.
deploy Yes string 7 to 16 - Deployment "IN_BAND"

Mode charac mode.
ters.
relyLld Yes boolea - - Whether to use true

p n LLDP relay.
precise Yes boolea - - Whether to false

Plan n perform
refined
planning.
manag No string 0 to 64 - Management "vpn"

eVpn charac VPN.
ters.
fabricI No string 0 to 36 - Fabric ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
fabric No string 0 to - Fabric name. "Fabric One"

Name 128
charac
ters.

iMaster NCE-Fabric

ftpIp Yes string 0 to 15 - FTP address. "192.168.1.1"

charac
ters.
ftpPort Yes int32 [0-655 0 FTP port 22

35] number.
ftpAcc Yes string 0 to 32 - FTP account. "admin"

ount charac
ters.
ftpPW Yes string 0 to - This field may "********"

DInfo 256 contain
charac sensitive or
Keep it secure.
FTP password.
ftpMer Yes boolea - - Whether to false

ge n enable FTP
backup.
ftpIpv6 No string 0 to 15 - IPv6 address of "fc00::/7"

charac the FTP server.
ters.
ftpPort No int32 [0-655 0 IPv6 port 22

v6 35] number of the
FTP server.
ftpAcc No string 0 to 32 - IPv6 account of "admin"

ountv6 charac the FTP server.
ters.
ftpPW No string 0 to - This field may "******"

DInfov 256 contain
6 charac sensitive or
Keep it secure.
IPv6 password
of the FTP
server.
backup No string 0 to 15 - IP address for "10.0.0.0"

FtpIp charac FTP backup.
ters.
backup No int32 [0-655 0 Port number 22

FtpPor 35] for FTP backup.
t

iMaster NCE-Fabric

backup No string 0 to 32 - Account for "admin"

FtpAcc charac FTP backup.
ount ters.
backup No string 0 to 32 - This field may "******"

FtpPW charac contain
DInfo ters. sensitive or
personal data.
Keep it secure.
Password for
FTP backup.
usedSl No boolea - - Whether the false

aveBac n backup FTP
kupFtp server is used.
slaveB No string 0 to 15 - IP address of "10.2.3.4"

ackupF charac the backup FTP
tpIp ters. server. The
value contains
0 to 15
characters.
slaveB No int32 [0-655 0 Port number of 22

ackupF 35] the backup FTP
tpPort server. The
value is in the
range from 0
to 65535.
slaveB No string 0 to 32 - Backup FTP "admin"

ackupF charac account. The
tpAcco ters. value contains
unt 0 to 32
characters.
slaveB No string 0 to 32 - This field may "******"

ackupF charac contain
tpPWD ters. sensitive or
Info personal data.
Keep it secure.
Password for
logging in to
the backup FTP
server. The
value contains
0 to 32
characters.

iMaster NCE-Fabric

dhcpIp No string 0 to 15 - IP address of "10.0.0.0"

charac the DHCP
ters. server. The
value is in the
range from 0
to 15.
region No string 0 to - Region "memo"

Memo 128 remarks.
charac
ters.
region No ARRAY For details, see Extended -

Extend _REFER Table 1-67. region
edList ENCE information.
Table 1-67 RegionExtendedDto parameters

extAttr Yes string 1 to - Extended "DBB702C3-77

Id 256 attribute value. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
extAttr Yes string 1 to - Extended "A-1"

Name 256 attribute name.
charac
ters.
extAttr Yes string 1 to - Extended "123"

Value 256 attribute ID.
charac
ters.
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/regions/region HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{

iMaster NCE-Fabric
"relyLldp" : true,
"ftpIp" : "192.168.1.1",
"ftpPort" : 22,
"ftpPWDInfo" : "********",
"ftpMerge" : false,
"ftpIpv6" : "fc00::/7",
"ftpPortv6" : 22,
"dhcpIp" : "10.0.0.0",
{
}
]
}
Response Parameters
Response status code 201: Created
Sample Response
HTTP/1.1 201 Created
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.1.7 Modify a Region
Typical Scenarios
Region information needs to be modified.
Functions
Modify a region.
Constraints
HTTP Method
PUT
URI
Request Parameters


ENCE Table 1-66. modifying a
region.
Sample Request
HTTP
PUT /sdn/acdcn/v3/underlay/ztp/regions/region HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
{
"relyLldp" : true,
"ftpIp" : "192.168.1.1",
"ftpPort" : 22,
"ftpPWDInfo" : "********",
"ftpMerge" : false,
"ftpIpv6" : "fc00::/7",
"ftpPortv6" : 22,
"dhcpIp" : "10.0.0.0",
{
}
]
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.1.8 Delete a Region by ID
Typical Scenarios
A region needs to be deleted.
Functions
Delete a region by ID.
Constraints
HTTP Method
DELETE
URI
Request Parameters


ENCE Table 1-70. deleting a
region.

iMaster NCE-Fabric
Table 1-70 RegionIdListDto parameters

regionI Yes array< Each - Region ID list. -

dList string> item
has 0
to 36
charac
ters.
Sample Request
HTTP
DELETE /sdn/acdcn/v3/underlay/ztp/regions/region HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"regionIdList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.2 L3 Multicast Serviceon Logical Router

Description of APIs for ZTP resource pool management:
1. Create and delete resource pools.
2. Obtain resource pools.
1.9.2.2.1 A resource pool needs to be created.
Typical Scenarios
A resource pool needs to be created.
Functions
Create resource pools based on related information.
Constraints
HTTP Method
POST
URI
/sdn/acdcn/v3/underlay/ztp/respool/region/{regionId}
Table 1-71 path parameters


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric
Request Parameters


resource pool.
Table 1-73 RespoolDto parameters

region No string 1 to 36 - Region ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
respool Yes ARRAY For details, see Resource pool. -

_REFER Table 1-74.
ENCE
Table 1-74 PoolDto parameters

pool Yes string ● Vla - Resource pool "Inter"

n type.
● Vte
p
● Mg
mt
● Inte
r
● Bgp
Pee
r
segme No ARRAY For details, see Resource pool -

nts _REFER Table 1-75. segment.
ENCE

iMaster NCE-Fabric
Table 1-75 SegmentDto parameters

id No string 1 to 64 - Resource pool "DBB702C3-77

charac ID, which is 19-4FE6-
ters. automatically A5AD-3A9C9E2
generated by 65309"
the controller
and does not
need to be
carried during
creation.
start No string 7 to 15 - Start IP "10.0.0.0"

charac address.
ters.
end No string 7 to 15 - End IP address. "10.0.0.1"

charac
ters.
mask No string [1-128 - IP address "24"

] mask of a
resource pool.
ip- No string ● Ipv4 - IP address type "Ipv4"

version of a resource
pool.
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/respool/region/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"region" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"respool" : [
{
"pool" : "Inter",
"segments" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"start" : "10.0.0.0",
"end" : "10.0.0.1",
"mask" : "24",
"ip-version" : "Ipv4"
}
]
}

iMaster NCE-Fabric
]
}
Response Parameters
Table 1-76 AddRespoolOutput parameters

eter t Value

A5AD-3A9C9E2
65309"
respool ARRAY For details, see Table Resource pool -

_REFER 1-77. list.
ENCE
Table 1-77 Respool parameters

eter t Value
respool string ● Vlan - Resource pool "Vlan"

Type type.
● Vtep
● Mgmt
● Inter
● BgpPeer
segme ARRAY For details, see Table Resource pool -

nts _REFER 1-78. data.
ENCE
Table 1-78 Segments parameters

eter t Value
id string 1 to 64 - Resource pool "DBB702C3-77

characters. ID. 19-4FE6-
A5AD-3A9C9E2
65309"
mask string [1-128] - IP address "24"

mask of a
resource pool.

iMaster NCE-Fabric

eter t Value
ipVersi string ● Ipv4 - IP address type "Ipv4"

on of a resource
pool.
startIp string 7 to 15 - Start IP "10.2.3.4"

characters. address.
endIp string 7 to 15 - End IP address. "10.2.3.5"

characters.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"respool" : [
{
"respoolType" : "Vlan",
"segments" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"mask" : "24",
"ipVersion" : "Ipv4",
"startIp" : "10.2.3.4",
"endIp" : "10.2.3.5"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.2.2 Query Resource Pools
Typical Scenarios
Resource pools need to be queried.
Functions
Query resource pools by region ID, IP version, and resource pool type.
Constraints
HTTP Method
GET
URI


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"

ip- No string ● Ipv4 - IP version. "Ipv4"

version

iMaster NCE-Fabric

pool- Yes string ● Vla - Resource pool "Vlan"

type n type.
● Vte
p
● Mg
mt
● Inte
r
● Bgp
Pee
r
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/respool/region/DBB702C3-7719-4FE6-A5AD-3A9C9E265309?ip-
version=Ipv4&pool-type=Vlan HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-81 RespoolDto parameters

eter t Value
region string 1 to 36 - Region ID. "DBB702C3-77

characters. 19-4FE6-
A5AD-3A9C9E2
65309"
respool ARRAY For details, see Table Resource pool. -

_REFER 1-82.
ENCE

iMaster NCE-Fabric

eter t Value
pool string ● Vlan - Resource pool "Inter"

● Vtep type.
● Mgmt
● Inter
● BgpPeer
segme ARRAY For details, see Table Resource pool -

nts _REFER 1-83. segment.
ENCE

eter t Value
id string 1 to 64 - Resource pool "DBB702C3-77

characters. ID, which is 19-4FE6-
automatically A5AD-3A9C9E2
generated by 65309"
the controller
and does not
need to be
carried during
creation.
start string 7 to 15 - Start IP "10.0.0.0"

end string 7 to 15 - End IP address. "10.0.0.1"

characters.
mask string [1-128] - IP address "24"

mask of a
resource pool.
ip- string ● Ipv4 - IP address type "Ipv4"

version of a resource
pool.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"region" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"respool" : [
{
"pool" : "Inter",
"segments" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"start" : "10.0.0.0",
"end" : "10.0.0.1",
"mask" : "24",
"ip-version" : "Ipv4"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.2.3 Delete Resource Pools
Typical Scenarios
Resource pools need to be deleted.
Functions
Delete resource pools by region ID and IP version.
Constraints

iMaster NCE-Fabric
HTTP Method
DELETE
URI


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
Request Parameters


resource pool.
Table 1-86 RespoolDeleteDto parameters

ip- No string ● Ipv4 - IP version. "Ipv4"

version
ids No array< - - Resource pool -

string> ID list. Only
one resource
pool ID can be
deleted at a
time.
Sample Request
HTTP
DELETE /sdn/acdcn/v3/underlay/ztp/respool/region/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"ip-version" : "Ipv4",
"ids" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.3 ZTP Whitelist Management

ZTP whitelist management APIs used to:
1. Create, delete, and query whitelists.
2. Download Chinese and English whitelist templates.

iMaster NCE-Fabric
1.9.2.3.1 Create a Whitelist
Typical Scenarios
A whitelist needs to be created.
Functions
Create a whitelist based on the planned information.
Constraints
HTTP Method
POST
URI
/sdn/acdcn/v3/underlay/ztp/whitelist
Request Parameters


whitelist.
Table 1-88 WhiteListWrapper parameters


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
dtoList Yes ARRAY For details, see Whitelist. -

_REFER Table 1-89.
ENCE
total- Yes int32 [0-214 0 Total number. 100

num 74836
47]

iMaster NCE-Fabric
Table 1-89 WhiteListDto parameters

esn No string 20 - Device serial "1234567890Q

charac number. Either WERTYUIOP"
ters. the device MAC
address or
device serial
number can be
selected.
mac No string 14 - Device MAC "0000-1122-33

charac address. Either 44"
ters. the device MAC
address or
device serial
number can be
selected.
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/whitelist HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"dtoList" : [
{
"esn" : "1234567890QWERTYUIOP",
"mac" : "0000-1122-3344"
}
],
"total-num" : 100
}
Response Parameters

iMaster NCE-Fabric
Table 1-90 WhiteListWrapper parameters

eter t Value

A5AD-3A9C9E2
65309"
dtoList ARRAY For details, see Table Whitelist. -

_REFER 1-91.
ENCE
total- int32 [0-2147483647 0 Total number. 100

num ]
Table 1-91 WhiteListDto parameters

eter t Value
esn string 20 characters. - Device serial "1234567890Q

number. Either WERTYUIOP"
the device MAC
address or
device serial
number can be
selected.
mac string 14 characters. - Device MAC "0000-1122-33

address. Either 44"
the device MAC
address or
device serial
number can be
selected.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"dtoList" : [
{
"mac" : "0000-1122-3344"
}
],
"total-num" : 100
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.3.2 Query Whitelists
Typical Scenarios
Whitelists need to be queried.
Functions
Query whitelist information based on keywords and other information.
Constraints
HTTP Method
GET
URI

iMaster NCE-Fabric


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
keywor No string 1 to 32 - Keyword. "dhc"

d charac
ters.
limit No int32 [0-655 0 Maximum 6

35] number of
records on a
page.
offset No int32 [0-655 0 Start location. -

35]
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/whitelist?regionId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&keyword=dhc&limit=6 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
WhiteListWrapper parameters, For details, see Table 1-90.
Sample Response

iMaster NCE-Fabric
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"dtoList" : [
{
"mac" : "0000-1122-3344"
}
],
"total-num" : 100
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.3.3 Delete Whitelists by region ID
Typical Scenarios
Delete Whitelists by region ID.
Functions
Delete whitelists by region ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric
Request Parameters


ENCE Table 1-94. deleting
whitelists.
Table 1-94 WhiteListIdsWrapper parameters


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
deviceI No array< - - Device ID list. -

dList string>
Sample Request
HTTP
DELETE /sdn/acdcn/v3/underlay/ztp/whitelist HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceIdList" : [
"CE39"
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4 ZTP Open Topology Management

ZTP open topology management APIs used to:
1. Query, verify, and import topology information.
2. Clear topology information.
1.9.2.4.1 Import Devices
Typical Scenarios
Devices need to be imported.
Functions
Import devices based on a data plan.
Constraints
HTTP Method
POST
URI
/sdn/acdcn/v3/underlay/ztp/topo/device

iMaster NCE-Fabric
Request Parameters


ENCE Table 1-96. importing
devices.
Table 1-96 TopologyImportDtoWrapper parameters

device- No int32 [0-214 0 Total number 100

total- 74836 of devices.
num 47]
l2link- No int32 [0-214 0 Total number 100

total- 74836 of Layer 2
num 47] links.
l3link- No int32 [0-214 0 Total number 100

total- 74836 of Layer 3
num 47] links.
operati No string 0 to 16 - Operation -

on- charac mode.
type ters.
device- No ARRAY For details, see Device list. -

list _REFER Table 1-97.
ENCE
l2link- No ARRAY For details, see Layer 2 link -

list _REFER Table 1-99. list.
ENCE
l3link- No ARRAY For details, see Layer 3 link -

list _REFER Table 1-101. list.
ENCE
region- Yes string 1 to 36 - Region ID. "DBB702C3-77

id charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
is- No boolea - - Whether to true

overwr n overwrite data.
itten

iMaster NCE-Fabric
Table 1-97 DeviceEntityDto parameters

ne- Yes string 1 to 64 - Device index. "CE39"

index charac
ters.
ne-role Yes string 1 to 32 - Device role. "Spine"

charac
ters.
sysna Yes string 0 to - Device name. "CE39"

me 256
charac
ters.
locatio No string 0 to - Location. "Nanjing"

n 256
charac
ters.
mgnt- No string 0 to 64 - Management "10.1.3.4/24"

ipv4 charac IPv4 address.
ters.
mgnt- No string 0 to - Management "fc00::/7"

ipv6 128 IPv6 address.
charac
ters.
vtep- No string 0 to 64 - VTEP IPv4 "10.1.3.4"

ipv4 charac address.
ters.
vtep- No string 0 to - VTEP IPv6 "fc00::/7"

ipv6 128 address.
charac
ters.
ztp- No int32 [0-214 0 ZTP level. 2

level 74836
47]
is- No boolea - - Whether to false

isolate n perform
isolation.
esn No string 0 to 20 - ESN. "1234567890Q

charac WERTYUIOP"
ters.

iMaster NCE-Fabric

stack No string 0 to - Stack. "Stack One"

256
charac
ters.
loopba No string 0 to 64 - IPv4 loopback. "10.1.3.4/24"

ck1- charac
ipv4 ters.
loopba No string 0 to 64 - Ipv6-loopback "fc00::/7"

ckX- charac
ipv6 ters.
status No string 0 to 32 - Status. "NORMAL"

charac
ters.
identifi No int32 [0-214 0 Identifier. 2

er 74836
47]
extend No ARRAY For details, see Extended -

_REFER Table 1-98. device
ENCE information.
Table 1-98 DeviceEntityExtendDto parameters

key- Yes string 0 to - Keyword. "abcd"

name 256
charac
ters.
value Yes string 0 to - Value. "abcd"

256
charac
ters.
Table 1-99 L2LinkEntityDto parameters

l2-link- No string 0 to 64 - Layer 2 link ID. "fc00::/7"

id charac
ters.

iMaster NCE-Fabric

ne- Yes string 0 to 64 - Local device "CEA"

index- charac index.
a ters.
port- Yes string 0 to 64 - Local port "10GE1/0/1"

a ters.
eth- No string 0 to 64 - Local Eth- "Eth-Trunk0"

trunk- charac Trunk.
no-a ters.
ne- Yes string 0 to 64 - Remote device "CEB"

b ters.
port- Yes string 0 to 64 - Remote port "10GE1/0/1"

b ters.
eth- No string 0 to 64 - Remote Eth- "Eth-Trunk0"

trunk- charac Trunk.
no-b ters.
status No string 0 to 32 - Status. "NORMAL"

charac
ters.
extend No ARRAY For details, see Extended Layer -

_REFER Table 1-100. 2 link
ENCE information.
Table 1-100 L2LinkEntityExtendDto parameters


name 256
charac
ters.

256
charac
ters.

iMaster NCE-Fabric

l3-link- No string 0 to 64 - Layer 3 link ID. "DBB702C3-77

id charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
ne- Yes string 0 to 64 - Local device "CEA"

a ters.
if-a Yes string 0 to 64 - Layer 3 "Vlanif1000"

charac interface of the
ters. local device.
ne-a- No string 0 to 64 - Interconnection "10.1.3.4/30"

conn- charac IPv4 address of
ipv4 ters. the local
device.
ne-a- No string 0 to - Interconnection "FE80::/10"

conn- 128 IPv6 address of
ipv6 charac the local
ters. device.
ne- Yes string 0 to 64 - Remote device "CEB"

b ters.
if-b Yes string 0 to 64 - Layer 3 "Vlanif1000"

charac interface of the
ters. remote device.
ne-b- No string 0 to 64 - Interconnection "10.2.3.4/30"

conn- charac IPv4 address of
ipv4 ters. the remote
device.
ne-b- No string 0 to - Interconnection "FE80::/10"

conn- 128 IPv6 address of
ipv6 charac the remote
ters. device.
extend No ARRAY For details, see Extended Layer -

_REFER Table 1-102. 3 link
ENCE information.

iMaster NCE-Fabric


name 256
charac
ters.

256
charac
ters.
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/topo/device HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"device-total-num" : 100,
"l2link-total-num" : 100,
"device-list" : [
{
"ne-index" : "CE39",
"ne-role" : "Spine",
"sysname" : "CE39",
"location" : "Nanjing",
"mgnt-ipv4" : "10.1.3.4/24",
"mgnt-ipv6" : "fc00::/7",
"vtep-ipv4" : "10.1.3.4",
"vtep-ipv6" : "fc00::/7",
"ztp-level" : 2,
"is-isolate" : false,
"stack" : "Stack One",
"loopback1-ipv4" : "10.1.3.4/24",
"loopbackX-ipv6" : "fc00::/7",
"status" : "NORMAL",
"identifier" : 2,
"extend" : [
{
"key-name" : "abcd",
"value" : "abcd"
}
]
}
],
"l2link-list" : [
{
"l2-link-id" : "fc00::/7",
"ne-index-a" : "CEA",
"port-index-a" : "10GE1/0/1",
"eth-trunk-no-a" : "Eth-Trunk0",
"ne-index-b" : "CEB",

iMaster NCE-Fabric
"port-index-b" : "10GE1/0/1",
"eth-trunk-no-b" : "Eth-Trunk0",
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l3link-list" : [
{
"l3-link-id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"if-a" : "Vlanif1000",
"ne-a-conn-ipv4" : "10.1.3.4/30",
"ne-a-conn-ipv6" : "FE80::/10",
"if-b" : "Vlanif1000",
"ne-b-conn-ipv4" : "10.2.3.4/30",
"ne-b-conn-ipv6" : "FE80::/10",
"extend" : [
{
"value" : "abcd"
}
]
}
],
"region-id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"is-overwritten" : true
}
Response Parameters
Table 1-103 SaveDeviceInfoOutput parameters

eter t Value
errMes string - - Error message. -

sage
errCod string - - Error message. -

e
Sample Response

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.2 Query Device Information
Typical Scenarios
Device information needs to be queried.
Functions
Query device information based on keywords and other information.
Constraints
HTTP Method
GET
URI

regioni Yes string 1 to 36 - Region ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric


d charac
ters.
limit Yes int32 [0-214 0 Size of a page 1

74836 recording
47] device query
information.
offset Yes int32 [0-214 0 Offset of a 1

74836 page recording
47] device query
information.
status No string ● STA - Device -

RT deployment
● EN status.
D
● AB
NO
RM
AL
● OFF
_LI
NE
onztp No boolea - - Whether ZTP is -

n in progress.
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/topo/device?regionid=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&keyword=region1&limit=1&offset=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-105 TopologyImportDtoWrapper parameters

eter t Value
device- int32 [0-2147483647 0 Total number 100

total- ] of devices.
num
l2link- int32 [0-2147483647 0 Total number 100

total- ] of Layer 2
num links.
l3link- int32 [0-2147483647 0 Total number 100

total- ] of Layer 3
num links.
operati string 0 to 16 - Operation -

on- characters. mode.
type
device- ARRAY For details, see Table Device list. -

list _REFER 1-106.
ENCE
l2link- ARRAY For details, see Table Layer 2 link -

list _REFER 1-108. list.
ENCE
l3link- ARRAY For details, see Table Layer 3 link -

list _REFER 1-110. list.
ENCE
region- string 1 to 36 - Region ID. "DBB702C3-77

id characters. 19-4FE6-
A5AD-3A9C9E2
65309"
is- boolea - - Whether to true

overwr n overwrite data.
itten

eter t Value
ne- string 1 to 64 - Device index. "CE39"

index characters.
ne-role string 1 to 32 - Device role. "Spine"

characters.

iMaster NCE-Fabric

eter t Value
sysna string 0 to 256 - Device name. "CE39"

me characters.
locatio string 0 to 256 - Location. "Nanjing"

n characters.
mgnt- string 0 to 64 - Management "10.1.3.4/24"

ipv4 characters. IPv4 address.
mgnt- string 0 to 128 - Management "fc00::/7"

ipv6 characters. IPv6 address.
vtep- string 0 to 64 - VTEP IPv4 "10.1.3.4"

ipv4 characters. address.
vtep- string 0 to 128 - VTEP IPv6 "fc00::/7"

ipv6 characters. address.
ztp- int32 [0-2147483647 0 ZTP level. 2

level ]
is- boolea - - Whether to false

isolate n perform
isolation.
esn string 0 to 20 - ESN. "1234567890Q

characters. WERTYUIOP"
stack string 0 to 256 - Stack. "Stack One"

characters.
loopba string 0 to 64 - IPv4 loopback. "10.1.3.4/24"

ck1- characters.
ipv4
loopba string 0 to 64 - Ipv6-loopback "fc00::/7"

ckX- characters.
ipv6
status string 0 to 32 - Status. "NORMAL"

characters.
identifi int32 [0-2147483647 0 Identifier. 2

er ]
extend ARRAY For details, see Table Extended -

_REFER 1-107. device
ENCE information.

iMaster NCE-Fabric
Table 1-107 DeviceEntityExtendDto parameters

eter t Value
key- string 0 to 256 - Keyword. "abcd"

name characters.
value string 0 to 256 - Value. "abcd"

characters.

eter t Value
l2-link- string 0 to 64 - Layer 2 link ID. "fc00::/7"

id characters.
ne- string 0 to 64 - Local device "CEA"

index- characters. index.
a
port- string 0 to 64 - Local port "10GE1/0/1"

a
eth- string 0 to 64 - Local Eth- "Eth-Trunk0"

trunk- characters. Trunk.
no-a
ne- string 0 to 64 - Remote device "CEB"

b
port- string 0 to 64 - Remote port "10GE1/0/1"

b
eth- string 0 to 64 - Remote Eth- "Eth-Trunk0"

trunk- characters. Trunk.
no-b
status string 0 to 32 - Status. "NORMAL"

characters.
extend ARRAY For details, see Table Extended Layer -

_REFER 1-109. 2 link
ENCE information.

iMaster NCE-Fabric

eter t Value

name characters.

characters.

eter t Value
l3-link- string 0 to 64 - Layer 3 link ID. "DBB702C3-77

id characters. 19-4FE6-
A5AD-3A9C9E2
65309"
ne- string 0 to 64 - Local device "CEA"

a
if-a string 0 to 64 - Layer 3 "Vlanif1000"

characters. interface of the
local device.
ne-a- string 0 to 64 - Interconnection "10.1.3.4/30"

conn- characters. IPv4 address of
ipv4 the local
device.
ne-a- string 0 to 128 - Interconnection "FE80::/10"

ipv6 the local
device.
ne- string 0 to 64 - Remote device "CEB"

b
if-b string 0 to 64 - Layer 3 "Vlanif1000"

characters. interface of the
remote device.
ne-b- string 0 to 64 - Interconnection "10.2.3.4/30"

ipv4 the remote
device.

iMaster NCE-Fabric

eter t Value
ne-b- string 0 to 128 - Interconnection "FE80::/10"

ipv6 the remote
device.
extend ARRAY For details, see Table Extended Layer -

_REFER 1-111. 3 link
ENCE information.

eter t Value

name characters.

characters.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"device-list" : [
{
"sysname" : "CE39",
"mgnt-ipv4" : "10.1.3.4/24",
"mgnt-ipv6" : "fc00::/7",
"vtep-ipv4" : "10.1.3.4",
"vtep-ipv6" : "fc00::/7",

iMaster NCE-Fabric
"ztp-level" : 2,
"loopback1-ipv4" : "10.1.3.4/24",
"identifier" : 2,
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l2link-list" : [
{
"l2-link-id" : "fc00::/7",
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l3link-list" : [
{
"ne-a-conn-ipv4" : "10.1.3.4/30",
"ne-a-conn-ipv6" : "FE80::/10",
"ne-b-conn-ipv4" : "10.2.3.4/30",
"ne-b-conn-ipv6" : "FE80::/10",
"extend" : [
{
"value" : "abcd"
}
]
}
],
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.3 Delete a Device
Typical Scenarios
A device needs to be deleted.
Functions
Delete a device.
Constraints
HTTP Method
DELETE
URI
Request Parameters


device.
Table 1-113 DeleteDevicesDto parameters

delete- Yes ARRAY For details, see List of devices -

devices _REFER Table 1-114. to be deleted.
ENCE

iMaster NCE-Fabric
Table 1-114 DeleteDeviceDto parameters


index charac
ters.
Sample Request
HTTP
DELETE /sdn/acdcn/v3/underlay/ztp/topo/device HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"delete-devices" : [
{
"ne-index" : "CE39"
}
]
}
Response Parameters
Table 1-115 DeleteDevicesOutput parameters

eter t Value

sage

e
Sample Response

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.4 Import Layer 2 Links
Typical Scenarios
Layer 2 links need to be imported.
Functions
Import Layer 2 links based on a data plan.
Constraints
HTTP Method
POST
URI
/sdn/acdcn/v3/underlay/ztp/topo/l2link

iMaster NCE-Fabric
Request Parameters

body Yes REFER For details, see Parametes for -

Layer 2 links.
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/topo/l2link HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"device-list" : [
{
"sysname" : "CE39",
"mgnt-ipv4" : "10.1.3.4/24",
"mgnt-ipv6" : "fc00::/7",
"vtep-ipv4" : "10.1.3.4",
"vtep-ipv6" : "fc00::/7",
"ztp-level" : 2,
"loopback1-ipv4" : "10.1.3.4/24",
"identifier" : 2,
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l2link-list" : [
{
"l2-link-id" : "fc00::/7",
"extend" : [

iMaster NCE-Fabric
{
"value" : "abcd"
}
]
}
],
"l3link-list" : [
{
"ne-a-conn-ipv4" : "10.1.3.4/30",
"ne-a-conn-ipv6" : "FE80::/10",
"ne-b-conn-ipv4" : "10.2.3.4/30",
"ne-b-conn-ipv6" : "FE80::/10",
"extend" : [
{
"value" : "abcd"
}
]
}
],
}
Response Parameters
Table 1-117 SaveL2LinkInfoOutput parameters

eter t Value

sage

e
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.5 Query Layer 2 Link Information
Typical Scenarios
Layer 2 links need to be queried.
Functions
Query Layer 2 link information based on a keyword.
Constraints
HTTP Method
GET
URI

regioni Yes string 1 to 36 - Region ID. "region1"

d charac
ters.
keywor No string 1 to 32 - Keyword. -

d charac
ters.

iMaster NCE-Fabric


74836 recording
47] device query
information.

47] device query
information.
status No string ● INIT - Layer 2 link -

IAL deployment
● NO status.
RM
AL
● AB
NO
RM
AL

n in progress.
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/topo/l2link?regionid=region1&limit=1&offset=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
TopologyImportDtoWrapper parameters, For details, see Table 1-105.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"device-list" : [
{
"sysname" : "CE39",
"mgnt-ipv4" : "10.1.3.4/24",
"mgnt-ipv6" : "fc00::/7",
"vtep-ipv4" : "10.1.3.4",
"vtep-ipv6" : "fc00::/7",
"ztp-level" : 2,
"loopback1-ipv4" : "10.1.3.4/24",
"identifier" : 2,
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l2link-list" : [
{
"l2-link-id" : "fc00::/7",
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l3link-list" : [
{
"ne-a-conn-ipv4" : "10.1.3.4/30",
"ne-a-conn-ipv6" : "FE80::/10",

iMaster NCE-Fabric
"ne-b-conn-ipv4" : "10.2.3.4/30",
"ne-b-conn-ipv6" : "FE80::/10",
"extend" : [
{
"value" : "abcd"
}
]
}
],
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.6 Import Layer 3 Links
Typical Scenarios
Layer 3 links need to be imported.
Functions
Import Layer 3 links based on a data plan.
Constraints
HTTP Method
POST
URI

iMaster NCE-Fabric
Request Parameters


Layer 3 links.
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/topo/l3link HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"device-list" : [
{
"sysname" : "CE39",
"mgnt-ipv4" : "10.1.3.4/24",
"mgnt-ipv6" : "fc00::/7",
"vtep-ipv4" : "10.1.3.4",
"vtep-ipv6" : "fc00::/7",
"ztp-level" : 2,
"loopback1-ipv4" : "10.1.3.4/24",
"identifier" : 2,
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l2link-list" : [
{
"l2-link-id" : "fc00::/7",
"extend" : [

iMaster NCE-Fabric
{
"value" : "abcd"
}
]
}
],
"l3link-list" : [
{
"ne-a-conn-ipv4" : "10.1.3.4/30",
"ne-a-conn-ipv6" : "FE80::/10",
"ne-b-conn-ipv4" : "10.2.3.4/30",
"ne-b-conn-ipv6" : "FE80::/10",
"extend" : [
{
"value" : "abcd"
}
]
}
],
}
Response Parameters
Table 1-120 SaveL3LinkInfoOutput parameters

eter t Value

sage

e
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.7 Query Layer 3 Links
Typical Scenarios
Functions
Query Layer 3 links based on a keyword.
Constraints
HTTP Method
GET
URI

regioni Yes string 1 to 36 - Region ID. "region1"

d charac
ters.

d charac
ters.

iMaster NCE-Fabric


74836 recording
47] device query
information.

47] device query
information.

n in progress.
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/topo/l3link?regionid=region1&keyword=region1&limit=1&offset=1 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
TopologyImportDtoWrapper parameters, For details, see Table 1-105.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"device-list" : [
{
"sysname" : "CE39",
"mgnt-ipv4" : "10.1.3.4/24",
"mgnt-ipv6" : "fc00::/7",
"vtep-ipv4" : "10.1.3.4",
"vtep-ipv6" : "fc00::/7",
"ztp-level" : 2,
"loopback1-ipv4" : "10.1.3.4/24",
"identifier" : 2,
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l2link-list" : [
{
"l2-link-id" : "fc00::/7",
"extend" : [
{
"value" : "abcd"
}
]
}
],
"l3link-list" : [
{
"ne-a-conn-ipv4" : "10.1.3.4/30",
"ne-a-conn-ipv6" : "FE80::/10",
"ne-b-conn-ipv4" : "10.2.3.4/30",
"ne-b-conn-ipv6" : "FE80::/10",
"extend" : [
{
"value" : "abcd"
}
]
}
],

iMaster NCE-Fabric
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.8 Query Extended Device Information
Typical Scenarios
Device information needs to be queried.
Functions
Query device information by device index.
Constraints
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/topo/deviceext/{neIndex}

neInde Yes string 0 to - Device index. "519491659"

x 256
charac
ters.

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/topo/deviceext/519491659 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
DeviceEntityDto parameters, For details, see Table 1-106.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"sysname" : "CE39",
"mgnt-ipv4" : "10.1.3.4/24",
"mgnt-ipv6" : "fc00::/7",
"vtep-ipv4" : "10.1.3.4",
"vtep-ipv6" : "fc00::/7",
"ztp-level" : 2,
"loopback1-ipv4" : "10.1.3.4/24",
"identifier" : 2,
"extend" : [
{
"value" : "abcd"
}
]
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.9 Query Extended Layer 2 Link Information
Typical Scenarios
Functions
Query Layer 2 link information by link ID.
Constraints
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/topo/l2linkext/{l2LinkId}

l2LinkI Yes string 0 to - Layer 2 link ID. "132165"

d 256
charac
ters.
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/topo/l2linkext/132165 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
L2LinkEntityDto parameters, For details, see Table 1-108.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l2-link-id" : "fc00::/7",
"extend" : [
{
"value" : "abcd"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.4.10 Query Extended Layer 3 Link Information
Typical Scenarios
Functions
Query Layer 3 link information by link ID.
Constraints
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/topo/l3linkext/{l3LinkId}

l3LinkI Yes string 0 to - Layer 3 link ID. "43129859"

d 256
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/topo/l3linkext/43129859 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
L3LinkEntityDto parameters, For details, see Table 1-110.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ne-a-conn-ipv4" : "10.1.3.4/30",
"ne-a-conn-ipv6" : "FE80::/10",
"ne-b-conn-ipv4" : "10.2.3.4/30",
"ne-b-conn-ipv6" : "FE80::/10",
"extend" : [
{
"value" : "abcd"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.2.4.11 Clear Topology Information by Region ID
Typical Scenarios
Topology information needs to be cleared by region ID.
Functions
Clear topology information by region ID.
Constraints
HTTP Method
DELETE
URI
/sdn/acdcn/v3/underlay/ztp/topo/topoinfo

regioni Yes string 1 to 36 - Region ID. "321553"

d charac
ters.
type Yes string 1 to 16 - Type. "INBAND"

charac
ters.
Request Parameters
N/A
Sample Request
HTTP
DELETE /sdn/acdcn/v3/underlay/ztp/topo/topoinfo?regionid=321553&type=INBAND HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.5 Task
1.9.2.5.1 Start ZTP Tasks
Typical Scenarios
Start ZTP Tasks.
Functions
Start ZTP tasks based on the region ID and device ID list.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/sdn/acdcn/v3/underlay/ztp/ztpmgnt/operation
Request Parameters


ENCE Table 1-127. starting ZTP
tasks.
Table 1-127 StartZtpTaskDtoWrapper parameters


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
deviceI No array< - - Device ID list. -

dList string>
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/ztpmgnt/operation HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceIdList" : [
"CE39"
]
}
Response Parameters

iMaster NCE-Fabric
Table 1-128 StartZtpOutput parameters

eter t Value

sage

e
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.5.2 Stop ZTP Tasks by Region ID
Typical Scenarios
ZTP tasks need to be stopped by region ID.
Functions
Stop ZTP tasks by region ID.
Constraints
HTTP Method
DELETE
URI
/sdn/acdcn/v3/underlay/ztp/ztpmgnt/operation

iMaster NCE-Fabric
Request Parameters


ENCE Table 1-130. stopping ZTP
tasks.
Table 1-130 StopZtpTaskDtoWrapper parameters


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
Sample Request
HTTP
DELETE /sdn/acdcn/v3/underlay/ztp/ztpmgnt/operation HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"regionId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
Response Parameters
Table 1-131 StopTaskDto parameters

eter t Value

A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
taskId string 1 to 64 - Task ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"taskId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
1.9.2.5.3 Update Device Ports
Typical Scenarios
The port of a managed device needs to be changed.
Functions
Update the device port based on the device ID and re-collect the port information.
Constraints
HTTP Method
POST
URI
/sdn/acdcn/v3/underlay/ztp/hostexpan/refreshport

iMaster NCE-Fabric
Request Parameters

body Yes REFER For details, see Device ID. -

ENCE Table 1-133.
Table 1-133 RefreshDevicePortDtoWrapper parameters

deviceI No string 1 to 38 - Device ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/hostexpan/refreshport HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
Response Parameters
Table 1-134 RefreshPortOutput parameters

eter t Value

sage

e

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.5.4 Query ZTP Tasks
Typical Scenarios
ZTP tasks need to be queried.
Functions
Query ZTP tasks based on the pagination information, device information, and
region ID.
Constraints
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/taskManagement/query

limit Yes int32 [0-214 0 Maximum 10

74836 number of
47] records on a
page.
offset Yes int32 [0-214 0 Start location. 100

74836
47]
deviceI Yes string 0 to 64 - Device "dhc"

nfo charac information.
ters.

iMaster NCE-Fabric


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/taskManagement/query?
limit=10&offset=100&deviceInfo=dhc&regionId=DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-136 DeviceTaskListDto parameters

eter t Value

dex ]

ze ]

cords ] of records.
data ARRAY For details, see Table List of online -

_REFER 1-137. devices.
ENCE

iMaster NCE-Fabric
Table 1-137 DeviceTaskDto parameters

eter t Value

A5AD-3A9C9E2
65309"

A5AD-3A9C9E2
65309"

Name characters.
deviceI string 0 to 64 - Device index. "CE39"

ndex characters.
device string 0 to 255 - Device name. "CE39"

Name characters.
manag string 0 to 18 - Management "10.0.0.0/24"

ementI characters. IP address.
p
status string 0 to 64 - Device status "PROCESS"

characters.
progre int32 [0-2147483647 0 Task progress 100

ss ]
inform string 0 to 256 - Task "START:

ation characters. information 2018/04/23
15:42:42"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"pageIndex" : 1,
"pageSize" : 10,
"data" : [
{
"taskId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceIndex" : "CE39",
"deviceName" : "CE39",
"managementIp" : "10.0.0.0/24",
"status" : "PROCESS",
"progress" : 100,
"information" : "START:2018/04/23 15:42:42"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.5.5 Query the Information About ZTP Tasks in All Regions
Typical Scenarios
ZTP tasks need to be queried on Day 0.
Functions
Query ZTP tasks based on the pagination information, device information, and
region ID.
Constraints
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/taskManagement/queryall

iMaster NCE-Fabric

limit Yes int32 [0-214 0 Start location. 10

74836
47]
offset Yes int32 [0-214 0 Maximum 100

74836 number of
47] records on a
page.
taskInf Yes string 0 to 64 - Task "dhc"

o charac information
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/taskManagement/queryall?limit=10&offset=100&taskInfo=dhc HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-139 regionTaskListDto parameters

eter t Value

dex ]

ze ]

cords ] of records.

iMaster NCE-Fabric

eter t Value
data ARRAY For details, see Table Data list. -

_REFER 1-140.
ENCE
Table 1-140 regionTaskDto parameters

eter t Value

A5AD-3A9C9E2
65309"
taskNa string 0 to 128 - Task name. "snapShot1"

me characters.

A5AD-3A9C9E2
65309"

Name characters.
operati string - - Operation "OPENING"

onType mode.
operati string - - Operation -

onTim time.
e
taskSt string 0 to 64 - Task status. "PROCESS"

atus characters.
progre int32 [0-2147483647 0 Task progress 100

ss ]
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"pageIndex" : 1,
"pageSize" : 10,

iMaster NCE-Fabric
"data" : [
{
"taskName" : "snapShot1",
"operationType" : "OPENING",
"taskStatus" : "PROCESS",
"progress" : 100
}
]
}
1.9.2.5.6 Query Syslog Information About ZTP Devices
Typical Scenarios
Syslog information needs to be queried when a device goes online on Day 0.
Functions
Query device syslog information based on the page information, device
information, log level, and task ID.
Constraints
HTTP Method
GET
URI
/sdn/acdcn/v3/underlay/ztp/taskManagement/syslog

pageSi Yes int32 [0-214 0 Page size. 20

ze 74836
47]
pageIn Yes int32 [1-214 0 Page index. 1

dex 74836
47]
taskId Yes string 0 to 64 - Task ID. "00000000-000

charac 0-0000-0000-0
ters. 00000000000"

iMaster NCE-Fabric

device Yes string 0 to Device name. "DTS"

Name 255 Either this
charac parameter or
ters. the device IP
address must
be set.
deviceI Yes string - Device IP "192.168.0.0"

p address. Either
this parameter
or the device
name must be
set.
logLev Yes string ● Info Inform Log level. "Informational"

el rma ational
tion
al
● War
nin
g
● Erro
r
precise Yes boolea - false Whether to true

n perform exact
match.
Request Parameters
N/A
Sample Request
HTTP
GET /sdn/acdcn/v3/underlay/ztp/taskManagement/syslog?
pageSize=20&pageIndex=1&taskId=00000000-0000-0000-0000-000000000000&deviceName=DTS&deviceIp=
192.168.0.0&logLevel=Informational&precise=true HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-142 DeviceSyslogDto parameters

eter t Value
sysNa string 0 to 64 - Device name. "Spine"

me characters.
esn string 0 to 128 - Device ESN. ""

characters.
mac string 0 to 36 - Device MAC "DBB702C3-77

characters. address. 19-4FE6-
A5AD-3A9C9E2
65309"
manag string 0 to 32 - Device ""

eIp characters. management
IP address.
logLev string ● Informationa - Log level. "Informational"

el l
● Warning
● Error
logInfo string - - Log -

information.
current string 0 to 64 - Time. "PROCESS"

Timest characters.
amp
taskId string - 0 Task ID. "100"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"sysName" : "Spine",
"esn" : "",
"mac" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"manageIp" : "",
"logLevel" : "Informational",
"currentTimestamp" : "PROCESS",
"taskId" : "100"
}

iMaster NCE-Fabric
1.9.2.5.7 Isolate Devices
Typical Scenarios
Devices need to be isolated.
Functions
Isolate devices based on device indexes, task IDs, and region IDs.
Constraints
HTTP Method
PUT
URI
/sdn/acdcn/v3/underlay/ztp/devicemgnt/isolation
Request Parameters

body Yes REFER For details, see Device -

ENCE Table 1-144. isolation
parameters.
Table 1-144 DeviceIsolateDto parameters


index charac
ters.

id charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
isIsolat Yes boolea - - Whether to true

e n perform
isolation.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /sdn/acdcn/v3/underlay/ztp/devicemgnt/isolation HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"isIsolate" : true
}
Response Parameters
Table 1-145 DeviceIsolateOutput parameters

eter t Value

sage

e
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.5.8 Replace Devices
Typical Scenarios
Devices need to be replaced.
Functions
Replace devices based on device indexes, task IDs, and region IDs.
Constraints
HTTP Method
PUT
URI
/sdn/acdcn/v3/underlay/ztp/devicemgnt/replace
Request Parameters

body Yes REFER For details, see Device -

ENCE Table 1-147. replacement
parameters.
Table 1-147 DeviceReplaceDto parameters


index charac
ters.

iMaster NCE-Fabric


id charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
esn No string 20 - ESN. "1234567890Q

charac WERTYUIOP"
ters.
Sample Request
HTTP
PUT /sdn/acdcn/v3/underlay/ztp/devicemgnt/replace HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"esn" : "1234567890QWERTYUIOP"
}
Response Parameters
Table 1-148 DeviceReplaceOutput parameters

eter t Value

sage

e

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.5.9 Reset Devices
Typical Scenarios
Devices need to be reset.
Functions
Reset devices by device index.
Constraints
HTTP Method
PUT
URI
/sdn/acdcn/v3/underlay/ztp/devicemgnt/reset

iMaster NCE-Fabric
Request Parameters

body Yes REFER For details, see Device reset -

ENCE Table 1-150. parameters.
Table 1-150 DeviceResetDto parameters

neInde No array< - - Device ID list. -

xList string>
Sample Request
HTTP
PUT /sdn/acdcn/v3/underlay/ztp/devicemgnt/reset HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"neIndexList" : [
"CE39"
]
}
Response Parameters
Table 1-151 DeviceResetOutput parameters

eter t Value

sage

e

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.6 ZTP Underlay Topology Management

ZTP underlay topology management APIs used to:
1. Export topology comparison information.
2. Query topology comparison information in pagination mode.
1.9.2.6.1 Export Topology Comparison Information
Typical Scenarios
Topology comparison information needs to be exported.
Functions
Export topology comparison information based on the status.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/sdn/acdcn/v3/underlay/ztp/underlayTopo/exportTopoInfo
Request Parameters


ENCE Table 1-153. exporting
topology
comparison
information.
Table 1-153 ExportTopoInfoDto parameters


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
status No string ● All - Status. "All"

● INIT
IAL
● NO
RM
AL
● AB
NO
RM
AL
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/underlayTopo/exportTopoInfo HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"status" : "All"
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.2.6.2 Query Topology Comparison Information
Typical Scenarios
Topology comparison information needs to be queried.
Functions
Query topology comparison information based on certain conditions.

iMaster NCE-Fabric
Constraints
HTTP Method
POST
URI
/sdn/acdcn/v3/underlay/ztp/underlayTopo/queryTopoByPage
Request Parameters


ENCE Table 1-155. querying
topology
comparison
information.
Table 1-155 QueryCompareTopoDto parameters


d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
taskId No string 0 to 64 - Task ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
status No string ● All - Status. "All"

● INIT
IAL
● NO
RM
AL
● AB
NO
RM
AL

iMaster NCE-Fabric

pageIn Yes int32 [0-214 0 Page index. 1

dex 74836
47]
pageSi Yes int32 [0-214 0 Page size. 10

ze 74836
47]
keywor No string 0 to - Keyword. "CE"

d 256
charac
ters.
Sample Request
HTTP
POST /sdn/acdcn/v3/underlay/ztp/underlayTopo/queryTopoByPage HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"status" : "All",
"pageIndex" : 1,
"pageSize" : 10,
"keyword" : "CE"
}
Response Parameters
Table 1-156 CompareTopoInfoWrapper parameters

eter t Value
compa ARRAY For details, see Table Topology -

reTopo _REFER 1-157. comparison
Info ENCE information.
countIt int32 [0-2147483647 0 Quantity. 10

eam ]

iMaster NCE-Fabric
Table 1-157 CompareTopoDto parameters

eter t Value
linkId string 0 to 64 - Link ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
localD string 0 to 64 - Local device. "CE39"

evice characters.
localD string 0 to 64 - Local device "CE39"

eviceIn characters. index.
dex
localM string 0 to 18 - Management "10.0.0.0/24"

gntIpv characters. IPv4 address of
4 the local
device.
localPo string 0 to 64 - Local port. "10GE1/0/1"

rt characters.
desPla string 0 to 64 - Planned "CE39"

nDevic characters. remote device.
e
desPla string 0 to 64 - Planned "CE39"

nDevic characters. remote device
eIndex index.
desPla string 0 to 64 - Planned "10GE1/0/1"

nPort characters. remote port.
desAct string 0 to 64 - Actual remote "CE39"

ualDev characters. device.
ice
desAct string 0 to 64 - Actual remote "CE39"

ualDev characters. device index.
iceInde
x
desAct string 0 to 64 - Actual remote "10GE1/0/1"

ualPort characters. port.
status string ● INITIAL - Link "INITIAL"

● NORMAL comparison
result: INITIAL,
● ABNORMAL NORMAL, and
ABNORMAL.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"compareTopoInfo" : [
{
"linkId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"localDevice" : "CE39",
"localDeviceIndex" : "CE39",
"localMgntIpv4" : "10.0.0.0/24",
"localPort" : "10GE1/0/1",
"desPlanDevice" : "CE39",
"desPlanDeviceIndex" : "CE39",
"desPlanPort" : "10GE1/0/1",
"desActualDevice" : "CE39",
"desActualDeviceIndex" : "CE39",
"desActualPort" : "10GE1/0/1",
"status" : "INITIAL"
}
],
"countIteam" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3 Physical Network
1.9.3.1 Physical Topology

# Description of the northbound API implementation of the physical topology:
1. Query the DCN physical topology.

iMaster NCE-Fabric
2. Query various resource pools and resource pool topologies of the DC network.
1.9.3.1.1 Query Device Groups
Typical Scenarios
Device groups need to be queried.
Functions
Query device groups by pool ID or device group ID.
Constraints
HTTP Method
GET
URI
/acdcn/v3/topoapi/dcntopo/devicegroup

iMaster NCE-Fabric

poolId No string 36 - ID of the "DBB702C3-77

charac connection 19-4FE6-
ters. pool. Either A5AD-3A9C9E2
The this parameter 65309"
value or device group
must ID can be set.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

id No string 36 - Device group "DBB702C3-77

charac ID. Either this 19-4FE6-
ters. parameter or A5AD-3A9C9E2
The poolId can be 65309"
value set.
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
pageSi No string 1 to - Page size. "1"

ze 255
charac
ters.
pageIn No string 1 to - Page index. "1"

dex 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /acdcn/v3/topoapi/dcntopo/devicegroup?poolId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&id=DBB702C3-7719-4FE6-A5AD-3A9C9E265309&pageSize=1&pageIndex=1 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Response status code 200: successfully
Table 1-159 DeviceGroupsWrapper parameters

eter t Value
device ARRAY For details, see Table Device group -

Groups _REFER 1-160. information.
ENCE
pageIn int64 [1-2147483647 - Page index. 1

dex ]
pageSi int64 [1-2147483647 - Page size. 1

ze ]
totalN int64 [1-2147483647 - Number of 1

um ] returned data
records.
Table 1-160 DeviceGroupDto parameters

eter t Value
poolId string 36 characters. - Resource pool "DBB702C3-77

The value must to which a 19-4FE6-
meet the device group A5AD-3A9C9E2
following belongs. 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
id string 36 characters. - Device group "DBB702C3-77

The value must ID. 19-4FE6-
meet the A5AD-3A9C9E2
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - Device group "10"

characters. name.
type string 1 to 255 - Device group "10"

characters. type. The
options are as
follows: 0:
Single 1: Active
2: StandBy 3:
Mirror
descrip string 0 to 255 - Device group "10"

tion characters. description.
device array< Each item has 1 - Device IDs in a -

string> to 36 device group.
characters.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"deviceGroups" : [
{
"poolId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",

iMaster NCE-Fabric
"type" : "10",
"description" : "10"
}
],
"pageIndex" : 1,
"pageSize" : 1,
"totalNum" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.1.2 Query Devices
Typical Scenarios
Devices need to be queried.
Functions
Query devices by pool ID or device ID.
Constraints
HTTP Method
GET
URI
/acdcn/v3/topoapi/dcntopo/device

iMaster NCE-Fabric

poolId No string 36 - ID of the "DBB702C3-77

charac connection 19-4FE6-
ters. pool. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

id No string 36 - Device ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

ze 255
charac
ters.

dex 255
charac
ters.
mac No string 1 to - MAC address "H-H-H-H-H-

255 of a device. H"
charac
ters.
ip No string 1 to - Management "172.16.1.1"

255 IP address of a
charac device.
ters.

iMaster NCE-Fabric

device No string 1 to - Device type. "VSWITCH"

Type 128 The value can
charac be VSWITCH,
ters. VDHCP,
SWITCH, EDGE,
or HOST.
Request Parameters
N/A
Sample Request
HTTP
GET /acdcn/v3/topoapi/dcntopo/device?poolId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&id=DBB702C3-7719-4FE6-A5AD-3A9C9E265309&pageSize=1&pageIndex=1&mac=H-
H-H-H-H-H&ip=172.16.1.1&deviceType=VSWITCH HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-162 DevicesWrapper parameters

eter t Value
devices ARRAY For details, see Table Device list -

_REFER 1-163. return result.
ENCE

dex ]

ze ]

um ] returned data
records.

iMaster NCE-Fabric
Table 1-163 DeviceDto parameters

eter t Value
id string 36 characters. - Device ID. "DBB702C3-77

The value must 19-4FE6-
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - Device name. "device1"

characters.
locatio string 0 to 255 - Device "nanjing"

n characters. location.
ip string 1 to 255 - Management "10.0.0.0"

characters. IP address of a
device.
status int32 [0-1] 1 Online/offline 1

status of a
device, which
can be 0
Online, 1
Offline, or 2
Subhealthy.
type string 1 to 255 - Device type, for "10"

characters. example,
switch, firewall,
or LB.
mac string 1 to 255 - MAC address "H-H-H-H-H-

characters. of a device. H"
mode string 1 to 255 - Device model. "CE6850"

characters.
vtepIp string 1 to 255 - NVE IP address. "192.168.1.2"

characters.
stack boolea - false Whether a -

n device is a
stack device or
not.

iMaster NCE-Fabric

eter t Value
memb REFER For details, see Table Device -

ers ENCE 1-164. member.

meet the device belongs. A5AD-3A9C9E2
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
softWa string 1 to 36 - Software "V100R020C10

re characters. version. "
cpuRat int32 [0-256] - CPU rate. 1

e
Table 1-164 DeviceMemDto parameters

eter t Value
type string 1 to 255 - Stack type. The "CSS"

characters. options are as
follows: 1: SVF
2: CSS 3: iStack
4: NONE
mastse string 1 to 255 - MAC address "H-H-H-H-H-

r characters. of a master H"
device.
standb string 1 to 255 - MAC address "H-H-H-H-H-

y characters. of a standby H"
device.
leaf array< 1-255 items. - MAC address -

string> of a leaf
device.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
{
"devices": [
{
"id": "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name": "device1",
"location": "nanjing",
"ip": "10.0.0.0",
"status": 0,
"type": "10",
"mac": "H-H-H-H-H-H",
"mode": "CE6850",
"vtepIp": "192.168.1.2",
"stack": false,
"members": {
"type": "CSS",
"mastser": "H-H-H-H-H-H",
"standby": "H-H-H-H-H-H",
"leaf": [
"leaf"
]
},
"poolId": "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"softWare": "string"
}
],
"pageIndex": 1,
"pageSize": 1,
"totalNum": 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.1.3 Query Host Links
Typical Scenarios
Host links need to be queried.
Functions
Query host links by link ID, switch ID, or vSwitch ID.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/acdcn/v3/topoapi/dcntopo/getHostlinks
Request Parameters

torHos No REFER For details, see Input -

tDto ENCE Table 1-166. parameter
model class.
Table 1-166 TorHostDto parameters

linkIdLi No array< 1-36 - Link ID list. -

st string> items.

iMaster NCE-Fabric

switchI No string 36 - ID of the TOR "DBB702C3-77

d charac switch at the 19-4FE6-
ters. peer end of the A5AD-3A9C9E2
The host. 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

vSwitc No string 36 - ID of the TOR "DBB702C3-77

hId charac switch 19-4FE6-
ters. connected to A5AD-3A9C9E2
The the host. 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
device No string 1 to 36 - Device type. "VSWITCH"

Type charac
ters.

ze 255
charac
ters.
pageIn No string [1-255 - Page index. "1"

dex ]
Sample Request
HTTP
POST /acdcn/v3/topoapi/dcntopo/getHostlinks HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
{
"switchId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vSwitchId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceType" : "VSWITCH",
"pageSize" : "1",
"pageIndex" : "1"
}
Response Parameters
Table 1-167 TorHostLinkWrapper parameters

eter t Value
linkList ARRAY For details, see Table Link -

_REFER 1-168. information.
ENCE

dex ]

ze ]

um ] returned data
records.
Table 1-168 LinkDto parameters

eter t Value
linkId string 36 characters. - Host link ID. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
hostId string 36 characters. - Host ID. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
hostNa string 1 to 255 - Host name. "10"

me characters.
hostM string 1 to 255 - MAC address "10"

ac characters. of the host
port.
switchI string 36 characters. - Switch ID. "DBB702C3-77

d The value must 19-4FE6-
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
switch string 36 characters. - Switch port ID. "DBB702C3-77

PortId The value must 19-4FE6-
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
switch string 1 to 255 - Switch port "10"

PortNa characters. name.
me

iMaster NCE-Fabric

eter t Value
trunkN string 1 to 36 - Eth-Trunk "10"

ame characters. attributes of
links on a
switch.
switchI string 1 to 36 - Switch IP "10.0.0.0"

p characters. address.
Sample Response
HTTP/1.1 200 OK
{
"linkList": [
{
"linkId": "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"hostId": "DBB702C3-7719-4FE6-A5AD-1A9C9E265309",
"hostName": "server1",
"hostMac": "10",
"switchId": "DBB702C3-7719-4FE6-A5AD-3A9C9E265319",
"switchPortId": "DBB702C3-7719-1FE6-A5AD-3A9C9E265309",
"switchPortName": "10",
"trunkName": "trunkName",
"switchIp": "10.0.0.0"
}
],
"pageIndex": 1,
"pageSize": 1,
"totalNum": 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.1.4 Query Hosts
Typical Scenarios
Hosts need to be queried.

iMaster NCE-Fabric
Functions
Query hosts by host ID list.
Constraints
HTTP Method
POST
URI
/acdcn/v3/topoapi/dcntopo/getHosts
Request Parameters

hostIds No REFER For details, see Input -

Dto ENCE Table 1-170. parameter
model class.
Table 1-170 HostIdsDto parameters

hostId No array< 1-36 - Host ID list. -

List string> items.

ze 255
charac
ters.

dex ]
Sample Request
HTTP
POST /acdcn/v3/topoapi/dcntopo/getHosts HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"pageSize" : "1",
"pageIndex" : "1"
}
Response Parameters
Table 1-171 HostWrapper parameters

eter t Value
hostLis ARRAY For details, see Table Host list. -

t _REFER 1-172.
ENCE

dex ]

ze ]

um ] returned data
records.
Table 1-172 HostDto parameters

eter t Value
deviceI string 36 characters. - Host name. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
hostNa string 1 to 255 - Host ID. "server1"

me characters.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"hostList" : [
{
"deviceId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"hostName" : "server1"
}
],
"pageIndex" : 1,
"pageSize" : 1,
"totalNum" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.1.5 Query Device Links
Typical Scenarios
Device links need to be queried.
Functions
Query device links based on localDeviceId and peerDeviceId.
Constraints
HTTP Method
POST
URI
/acdcn/v3/topoapi/dcntopo/getLinks

iMaster NCE-Fabric
Request Parameters

linksDt No REFER For details, see Input -

o ENCE Table 1-174. parameter
model class.
Table 1-174 LinksDto parameters

localD No string 36 - Source device "DBB702C3-77

eviceId charac ID. 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

peerDe No string 36 - Destination "DBB702C3-77

viceId charac device. 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

ze 255
charac
ters.

dex ]
Sample Request
HTTP
POST /acdcn/v3/topoapi/dcntopo/getLinks HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"localDeviceId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peerDeviceId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"pageSize" : "1",

iMaster NCE-Fabric
"pageIndex" : "1"
}
Response Parameters
Table 1-175 LinksWrapper parameters

eter t Value
links ARRAY For details, see Table Link -

ENCE

dex ]

ze ]

um ] returned data
records.
Table 1-176 LinkInfoDto parameters

eter t Value
trunk boolea - - Whether a link true

n is a trunk link.
status int32 [0-1] - Link status, 1

which can be 0
(DOWN) or 1
(UP).
mode int32 [1-4] - Link type. The 1

options are as
follows: 1:
Internal link 2:
External link 3:
Internal and
external link 4:
Common link
localN REFER For details, see Table Link node -

ode ENCE 1-177. information.

iMaster NCE-Fabric

eter t Value
peerN REFER For details, see Table Link node -

ode ENCE 1-177. information.
trunk ARRAY For details, see Table Trunk member. -

Mems _REFER 1-178.
ENCE
Table 1-177 LinkNode parameters

eter t Value
poolId string 36 characters. - ID of the "DBB702C3-77

The value must resource pool 19-4FE6-
meet the to which the A5AD-3A9C9E2
following device belongs. 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
deviceI string 1 to 255 - Management "192.168.1.1"

p characters. IP address of a
device.
deviceI string 36 characters. - ID of a device. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
device string 1 to 255 - Device name. "CE6883_125.6.

Name characters. 123.37"
port string 1 to 255 - Port name. "gig3/0/1"

characters.

iMaster NCE-Fabric
Table 1-178 TrunkMemDto parameters

eter t Value
id string 36 characters. - Trunk link ID. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
localPo string 1 to 255 - Name of the "gig3/0/0"

rt characters. local port, that
is, the port on
the local node.
peerPo string 1 to 255 - Name of the "gig3/0/1"

rt characters. peer port, that
is, the port on
the peer node.
linkMo int32 [1-255] - Sub-link type. 10

de The options are
as follows: 1:
Internal link 2:
External link 3:
Internal and
external links
4: Common
link
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{

iMaster NCE-Fabric
"links" : [
{
"trunk" : true,
"status" : 1,
"mode" : 1,
"localNode" : {
"deviceIp" : "192.168.1.1",
"deviceName" : "CE6883_125.6.123.37",
"port" : "gig3/0/1"
},
"peerNode" : {
"deviceIp" : "192.168.1.1",
"deviceName" : "CE6883_125.6.123.37",
"port" : "gig3/0/1"
},
"trunkMems" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"localPort" : "gig3/0/0",
"peerPort" : "gig3/0/1",
"linkMode" : 10
}
]
}
],
"pageIndex" : 1,
"pageSize" : 1,
"totalNum" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.1.6 Query All Ports
Typical Scenarios
Ports need to be queried.
Functions
Query the port list based on deviceIdList.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/acdcn/v3/topoapi/dcntopo/getPorts
Request Parameters

deviceI Yes REFER For details, see Input -

dDto ENCE Table 1-180. parameter
model class.
Table 1-180 DeviceIdsDto parameters

deviceI No array< 1-36 - Device ID. -

dList string> items.
portLis No ARRAY For details, see Port -

t _REFER Table 1-181. information
ENCE list.

ze 255
charac
ters.

dex ]

iMaster NCE-Fabric
Table 1-181 portListDto parameters

deviceI No string 36 - Device ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
ifNam No string 1 to - Port name of a "Eth-trunk1"

e 255 device.
charac
ters.
Sample Request
HTTP
POST /acdcn/v3/topoapi/dcntopo/getPorts HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceIdList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"portList" : [
{

iMaster NCE-Fabric
"ifName" : "Eth-trunk1"
}
],
"pageSize" : "1",
"pageIndex" : "1"
}
Response Parameters
Table 1-182 DevicePortWrapper parameters

eter t Value
device ARRAY For details, see Table Port -

PortLis _REFER 1-183. information
t ENCE list.

dex ]

ze ]
totalN int64 [1-2147483647 - Total number 1

um ] of records.
Table 1-183 DevicePortDto parameters

eter t Value
deviceI string 36 characters. - Physical device "DBB702C3-77

d The value must ID. 19-4FE6-
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
portLis ARRAY For details, see Table Port list, which -

t _REFER 1-184. supports
ENCE physical ports,
trunk
interfaces, and
Layer 2 sub-
interfaces.
Table 1-184 PortDto parameters

eter t Value
portId string 36 characters. - Port ID. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
portNa string 1 to 255 - Port name. "10GE1/0/2"

me characters.
portSt string 1 to 255 - Port status, "UP"

atus characters. which can be
UP or DOWN.
ethTru string 1 to 255 - Name of the "Eth-Trunk11"

nkNa characters. Eth-Trunk
me interface to
which the port
belongs.
portM string 1 to 255 - MAC address "H-H-H-H-H-

ac characters. of a port. H"
portSp string 1 to 255 - Port speed. "1"

eed characters.
portIp string 1 to 255 - Port IP address. "192.168.0.0"

characters.

iMaster NCE-Fabric

eter t Value
portTy string 1 to 255 - Port type. "IFMIPHYTYPE

pe characters. ETHTRUNK"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"devicePortList" : [
{
"portList" : [
{
"portId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"portName" : "10GE1/0/2",
"portStatus" : "UP",
"ethTrunkName" : "Eth-Trunk11",
"portMac" : "H-H-H-H-H-H",
"portSpeed" : "1",
"portIp" : "192.168.0.0",
"portType" : "IFMIPHYTYPEETHTRUNK"
}
]
}
],
"pageIndex" : 1,
"pageSize" : 1,
"totalNum" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.1.7 Query Topologies in a Resource Pool
Typical Scenarios
Topologies in a resource pool need to be queried.

iMaster NCE-Fabric
Functions
Query the topologies in a resource pool by pool ID.
Constraints
HTTP Method
GET
URI
/acdcn/v3/topoapi/dcntopo/pool/{poolId}

poolId Yes string 36 - ID of the "DBB702C3-77

charac resource pool 19-4FE6-
ters. to which a A5AD-3A9C9E2
The device group 65309"
value belongs.
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /acdcn/v3/topoapi/dcntopo/pool/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-186 PoolViewWrapper parameters

eter t Value

Groups _REFER 1-160. list.
ENCE
devices ARRAY For details, see Table Device -

_REFER 1-163. information
ENCE list.
links ARRAY For details, see Table Information -

_REFER 1-176. about links
ENCE between
devices.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"deviceGroups" : [
{

iMaster NCE-Fabric
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"type" : "10",
}
],
"devices" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "device1",
"location" : "nanjing",
"ip" : "10.0.0.0",
"status" : 1,
"type" : "10",
"mac" : "H-H-H-H-H-H",
"mode" : "CE6850",
"vtepIp" : "192.168.1.2",
"members" : {
"type" : "CSS",
"mastser" : "H-H-H-H-H-H",
"standby" : "H-H-H-H-H-H"
},
"softWare" : "V100R020C10",
"cpuRate" : 1
}
],
"links" : [
{
"trunk" : true,
"status" : 1,
"mode" : 1,
"localNode" : {
"deviceIp" : "192.168.1.1",
"deviceName" : "CE6883_125.6.123.37",
"port" : "gig3/0/1"
},
"peerNode" : {
"deviceIp" : "192.168.1.1",
"deviceName" : "CE6883_125.6.123.37",
"port" : "gig3/0/1"
},
"trunkMems" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"localPort" : "gig3/0/0",
"peerPort" : "gig3/0/1",
"linkMode" : 10
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.3.1.8 Query the DCN Network Topology
Typical Scenarios
The DCN topology needs to be queried.
Functions
Query the DCN network topology, including the fabric resource pools and VAS
resource pools.
Constraints
HTTP Method
GET
URI
/acdcn/v3/topoapi/dcntopo/resourcepool
Request Parameters
N/A
Sample Request
HTTP
GET /acdcn/v3/topoapi/dcntopo/resourcepool HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-187 DomainViewWrapper parameters

eter t Value
pools ARRAY For details, see Table Resource pool -

ENCE list.

iMaster NCE-Fabric

eter t Value
links ARRAY For details, see Table Connection -

_REFER 1-189. relationships
ENCE between
resource pools.

eter t Value
id string 36 characters. - Resource pool "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - Resource pool "fabric1"

characters. name.
type int32 [0-1] - Resource pool 1

type. The
options are as
follows: 1:
Fabric resource
pool 2: VAS
resource pool
vastyp string 0 to 255 - VAS resource "Firewall"

e characters. pool type.
descrip string 1 to 255 - Resource pool "this is fabric in

tion characters. description. beijing"

iMaster NCE-Fabric
Table 1-189 PoolLinkDto parameters

eter t Value
localPo string 36 characters. - ID of the local "DBB702C3-77

olId The value must resource pool. 19-4FE6-
meet the Generally, it is A5AD-3A9C9E2
following the ID of the 65309"
regular fabric resource
expression: pool.
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
peerPo string 36 characters. - ID of the peer "DBB702C3-77

olId The value must resource pool. 19-4FE6-
meet the Generally, it is A5AD-3A9C9E2
following the ID of the 65309"
regular VAS resource
expression: pool.
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"pools" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "fabric1",
"type" : 1,
"vastype" : "Firewall",
"description" : "this is fabric in beijing"
}
],
"links" : [

iMaster NCE-Fabric
{
"localPoolId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peerPoolId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.1.9 Bypass Link Compatibility Configuration for Upgrade
Typical Scenarios
The number of services referenced by the bypass link need to be counted during
the upgrade from Agile Controller-DCN C00 to a later version.
Functions
Configure the bypass link to make it compatible with the version after the
upgrade.
Constraints
HTTP Method
POST
URI
/acdcn/v3/topoapi/dcntopo/upgrade/escape/links
Request Parameters
N/A
Sample Request
HTTP
POST /acdcn/v3/topoapi/dcntopo/upgrade/escape/links HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-190 ErrorInfo parameters

eter t Value
errCod string 1 to 128 - error code "13107201"

e characters.
errPara array< Each item has 1 - error paras -

s string> to 128
characters.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"errCode" : "13107201",
"errParas" : [
"13af679b-b8f4-3744-9aaa-d588b957c999"
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.1.10 Query the Bypass Link
Typical Scenarios
This API needs to be invoked to query the bypass link of a device.
Functions
Query the bypass link of a device.

iMaster NCE-Fabric
Constraints
HTTP Method
GET
URI
/acdcn/v3/topoapi/dcntopo/deviceEscapeLinks

device No string - - Device group -

GroupI ID.
d
Request Parameters
N/A
Sample Request
HTTP
GET /acdcn/v3/topoapi/dcntopo/deviceEscapeLinks HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-192 EscapeLinksResponse parameters

eter t Value
result ARRAY For details, see Table Bypass link -

ENCE
device string - - deviceGroupId. -

GroupI
d

iMaster NCE-Fabric
Table 1-193 EscapeLinksInfoDto parameters

eter t Value
leftPor string - - leftPortName. -

tName
leftDev string - - leftDeviceId. -

iceId
leftDev string - - leftDeviceNam -

iceNa e.
me
leftPor string - - leftPortId. -

tId
leftEth string - - leftEthTrunkNa -

Trunk me.
Name
rightD string - - rightDeviceId. -

eviceId
rightD string - - rightDeviceNa -

eviceN me.
ame
rightPo string - - rightPortId. -

rtId
rightPo string - - rightPortName. -

rtNam
e
rightEt string - - rightEthTrunkN -

hTrunk ame.
Name
refFlag boolea - - refFlag. -

n
linkTyp int32 - - linkType. -

e
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2 Fabric
API description:
1. Query the fabric pool list.
1.9.3.2.1 Create a Fabric
Typical Scenarios
A fabric needs to be created.
Functions
Create a fabric.
Constraints
Concurrency specification: ≤ 200 times/minute.
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabrics
Request Parameters
Paramet Type Value Default Descripti Example

er Range Value on
input REFERE For details, see Table Fabric -

NCE 1-195. pool
configurat
ion.

iMaster NCE-Fabric
Table 1-195 FabricListRestfulDtoWrapper parameters

fabric Yes ARRAY 0-1000 items. Fabric -

_REFER For details, see information.
ENCE Table 1-196.
totalN No string - - Number of "1"

um queried fabrics.
Table 1-196 FabricDto parameters

id Yes string 0 to - Fabric ID. "dbb702c3-771

256 9-4fe6-
charac a5ad-3a9c9e26
ters. 5309"
name Yes string 1 to - Fabric name. "Fabric"

128
charac
ters.
descrip No string 0 to - Fabric "description"

tion 255 description.
charac
ters.
networ Yes string 1 to - Fabric VXLAN "Distributed"

kType 128 type. The value
charac is Distributed
ters. or Centralized.
physic Yes string 1 to Vxlan Fabric "Vxlan"

alNetw 128 networking
orkMo charac type. Only
de ters. VXLAN is
supported.
bgpEv No boolea - true Whether BGP true

pnEna n EVPN is
ble enabled.

iMaster NCE-Fabric

extInte No string 1 to Vbdif Outbound "Vbdif"

rfaceTy 128 interface type.
pe charac The interface
ters. can be VBDIF
or VLANIF
interface.
arpBro No boolea - false Whether to false

adcast n enable ARP
Suppre broadcast
ssion suppression.
dciSplit No string 0 to 32 - DCI split "1"

Group charac horizon group
ters. ID. The value
range is from 1
to 32.
microS Yes boolea - false Whether to false

egmen n enable
tCapab microsegmenta
ility tion.
multic No boolea - false Whether the false

astCap n multicast
ability capability is
supported.
segme No array< 0-2147 - Mask -

ntMas string> 48364 parameter.
ks 7
items.
aclMo No string 1 to 32 - Whether ACL6 "loose"

del charac is supported.
ters.
sfcCap No string 1 to 32 - SFC capability. "Pbr"

ability charac
ters.
faultSe No boolea - - faultService false

rvice n

iMaster NCE-Fabric

underL No string - - Underlay "BGP"

ay routing
protocol.
Currently, BGP,
OSPF, and
other are
supported.
manag No string - - Management "INBAND"

ement mode.
Currently,
INBAND and
OUTBAND are
supported.
localCr No string - - ERT for local "2:100"

ossErt route leaking
on a fabric.
sdnMo No boolea - - Whether the true

de n SDN mode is
supported.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/fabricresource/fabrics HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"fabric" : [
{
"id" : "dbb702c3-7719-4fe6-a5ad-3a9c9e265309",
"name" : "Fabric",
"description" : "description",
"networkType" : "Distributed",
"physicalNetworkMode" : "Vxlan",
"bgpEvpnEnable" : true,
"extInterfaceType" : "Vbdif",
"arpBroadcastSuppression" : false,
"dciSplitGroup" : "1",
"microSegmentCapability" : false,
"multicastCapability" : false,
"aclModel" : "loose",
"sfcCapability" : "Pbr",
"faultService" : false,
"underLay" : "BGP",
"management" : "INBAND",
"localCrossErt" : "2:100",
"sdnMode" : true

iMaster NCE-Fabric
}
],
"totalNum" : "1"
}
Response Parameters
Table 1-197 FabricListRestfulDtoWrapper parameters

eter t Value
fabric ARRAY 0-1000 items. For details, Fabric -

_REFER see Table 1-198. information.
ENCE
totalN string - - Number of "1"

um queried fabrics.
Table 1-198 FabricDto parameters

eter t Value
id string 0 to 256 - Fabric ID. "dbb702c3-771

characters. 9-4fe6-
a5ad-3a9c9e26
5309"
name string 1 to 128 - Fabric name. "Fabric"

characters.
descrip string 0 to 255 - Fabric "description"

networ string 1 to 128 - Fabric VXLAN "Distributed"

kType characters. type. The value
is Distributed
or Centralized.
physic string 1 to 128 Vxlan Fabric "Vxlan"

alNetw characters. networking
orkMo type. Only
de VXLAN is
supported.
bgpEv boolea - true Whether BGP true

pnEna n EVPN is
ble enabled.

iMaster NCE-Fabric

eter t Value
extInte string 1 to 128 Vbdif Outbound "Vbdif"

rfaceTy characters. interface type.
pe The interface
can be VBDIF
or VLANIF
interface.
arpBro boolea - false Whether to false

adcast n enable ARP
Suppre broadcast
ssion suppression.
dciSplit string 0 to 32 - DCI split "1"

Group characters. horizon group
ID. The value
range is from 1
to 32.
microS boolea - false Whether to false

egmen n enable
tCapab microsegmenta
ility tion.
multic boolea - false Whether the false

astCap n multicast
supported.
segme array< 0-2147483647 - Mask -

ntMas string> items. parameter.
ks
aclMo string 1 to 32 - Whether ACL6 "loose"

del characters. is supported.
sfcCap string 1 to 32 - SFC capability. "Pbr"

ability characters.
faultSe boolea - - faultService false

rvice n
underL string - - Underlay "BGP"

ay routing
protocol.
Currently, BGP,
OSPF, and
other are
supported.

iMaster NCE-Fabric

eter t Value
manag string - - Management "INBAND"

ement mode.
Currently,
INBAND and
OUTBAND are
supported.
localCr string - - ERT for local "2:100"

ossErt route leaking
on a fabric.
sdnMo boolea - - Whether the true

de n SDN mode is
supported.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fabric" : [
{
"id" : "dbb702c3-7719-4fe6-a5ad-3a9c9e265309",
"name" : "Fabric",
"underLay" : "BGP",
"sdnMode" : true
}
],
"totalNum" : "1"
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.2 Query All Fabric Pools
Typical Scenarios
All fabric pools need to be queried.
Functions
Query all fabric pools.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabrics


dex 4000
charac
ters.

ze 4000
charac
ters.
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/fabricresource/fabrics?pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
FabricListRestfulDtoWrapper parameters, For details, see Table 1-197.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fabric" : [
{
"id" : "dbb702c3-7719-4fe6-a5ad-3a9c9e265309",
"name" : "Fabric",
"underLay" : "BGP",
"sdnMode" : true
}
],
"totalNum" : "1"
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.3.2.3 Query a Fabric by ID
Typical Scenarios
Query a Fabric by ID.
Functions
Query a fabric by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabrics/fabric/{id}

id Yes string 0 to - ID for deleting "DBB702C3-77

256 a fabric. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/fabricresource/fabrics/fabric/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fabric" : [
{
"id" : "dbb702c3-7719-4fe6-a5ad-3a9c9e265309",
"name" : "Fabric",
"underLay" : "BGP",
"sdnMode" : true
}
],
"totalNum" : "1"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.4 Update a Fabric by ID
Typical Scenarios
A fabric needs to be updated by ID.

iMaster NCE-Fabric
Functions
Update a fabric by ID.
Constraints
HTTP Method
PUT
URI

id Yes string 0 to - ID for updating "DBB702C3-77

256 a fabric. This 19-4FE6-
charac field cannot be A5AD-3A9C9E2
ters. updated. 65309"
Request Parameters

er Range Value on
input REFERE For details, see Table Fabric -

NCE 1-195. configurat
ion.
Sample Request
HTTP
PUT /controller/dc/v3/physicalnetwork/fabricresource/fabrics/fabric/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{

iMaster NCE-Fabric
"fabric" : [
{
"id" : "dbb702c3-7719-4fe6-a5ad-3a9c9e265309",
"name" : "Fabric",
"underLay" : "BGP",
"sdnMode" : true
}
],
"totalNum" : "1"
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fabric" : [
{
"id" : "dbb702c3-7719-4fe6-a5ad-3a9c9e265309",
"name" : "Fabric",
"underLay" : "BGP",
"sdnMode" : true

iMaster NCE-Fabric
}
],
"totalNum" : "1"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.5 Delete a Fabric by ID
Typical Scenarios
A fabric needs to be deleted by ID.
Functions
Delete a fabric by ID.
Constraints
HTTP Method
DELETE
URI


charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
DELETE /controller/dc/v3/physicalnetwork/fabricresource/fabrics/fabric/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
HTTP/1.1 204 No Content
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.6 Query a Device Group with a Specified Role in a Specified Fabric
Typical Scenarios
A device group with a specified role in a specified fabric needs to be queried.
Functions
Query a device group with a specified role in a specified or all fabrics.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabric-nodes

fabricI No string 0 to - fabricID "aecd1cb4-

d 256 b76a-405e-
charac a5ed-
ters. cb44744a2f3c"
nodeR No string 0 to - Role type of a "DCI"

ole 255 device group,
charac for example,
ters. DCI.

dex 4000
charac
ters.

ze 4000
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/fabricresource/fabric-nodes?fabricId=aecd1cb4-b76a-405e-a5ed-
cb44744a2f3c&nodeRole=DCI&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-205 FabricNodesListWrapper parameters

eter t Value
fabric ARRAY For details, see Table fabric node list -

Nodes _REFER 1-206.
List ENCE
totalN string - - Number of "1"

um queried fabric
device groups.
Table 1-206 FabricNodesDto parameters

eter t Value
id string 0 to 256 - Device ID. "c45b0dd9-

characters. fb41-3cf4-925a
-103ad846df9e
"
fabricI string 0 to 256 - Fabric ID. "c45b0dd9-

d characters. fb41-3cf4-925a
-103ad846df9e
"
fabric string 1 to 128 - Fabric name. -

Name characters.
name string 1 to 128 - Device name. "c45b0dd9-

characters. fb41-3cf4-925a
-103ad846df9e
"
nodeR string 0 to 255 - Role type of a "DCI"

ole characters. device group,
for example,
DCI.
vtepIp string 0 to 255 - VTEP IP "10.1.1.1"

characters. address of a
device group.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fabricNodesList" : [
{
"id" : "c45b0dd9-fb41-3cf4-925a-103ad846df9e",
"fabricId" : "c45b0dd9-fb41-3cf4-925a-103ad846df9e",
"name" : "c45b0dd9-fb41-3cf4-925a-103ad846df9e",
"nodeRole" : "DCI",
"vtepIp" : "10.1.1.1"
}
],
"totalNum" : "1"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.7 Query the Name and Usage of a Sub-resource
Typical Scenarios
The name and usage of a logical resource need to be queried.
Functions
Query the name and usage of child resources based on the parent resource ID.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabrics/logicresusage

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table Input -

NCE 1-208. paramete
r for
querying
the sub-
resource.
Table 1-208 queryResDtoWrapper parameters

id Yes string 1 to 72 - Parent resource "c45b0dd9-

charac ID. The value fb41-3cf4-925a
ters. DCNService:FA -103ad846df9e
BRIC:MAX_FAB "
RIC_EGRESS_G
ATEWAY
indicates that
all parent
resources are
queried.
pageIn No int32 0 to - Page index. 5

dex 255
charac
ters.
pageSi No int32 0 to - Page size. 5

ze 255
charac
ters.
order No string 0 to - Order. "desc"

255
charac
ters.
orderV No string 0 to - Order. "logicResource

alue 255 Name"
charac
ters.

iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/fabricresource/fabrics/logicresusage HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "c45b0dd9-fb41-3cf4-925a-103ad846df9e",
"pageIndex" : 5,
"pageSize" : 5,
"order" : "desc",
"orderValue" : "logicResourceName"
}
Response Parameters
Table 1-209 LogicResourceUsageDtoWrapper parameters

eter t Value
resInfo ARRAY For details, see Table Related -

es _REFER 1-210. information.
ENCE
totalN int32 - - ResourceTotalN -

um um
Table 1-210 LogicResourceUsageDto parameters

eter t Value
service string - - LogicResource -

Parent name
Name
service string - - ResourceId -

ParentI
d
usedN int32 - - ResourceUsage -

um Num

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.8 Query the Total Number and Usage of Resources
Typical Scenarios
The total number and usage of static resources needs to be queried.
Functions
Query the total amount and usage of static resources based on neId.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabrics/resourceusage/{neId}

neId Yes string 0 to - Device ID. "cd76c5db-

256 bc96-36b4-988
charac 8-
ters. d76495ff333c"

iMaster NCE-Fabric
Request Parameters

dtid No string 0 to - Transaction ID. "G2019061209

256 4934616_25e4
charac 586-
ters. eb8a-4ee1-902
b-
ad5205e617c7
d"
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/fabricresource/fabrics/resourceusage/cd76c5db-bc96-36b4-9888-
d76495ff333c HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
dtid: "G20190612094934616_25e4586-eb8a-4ee1-902b-ad5205e617c7d"
Response Parameters
Table 1-213 StaticResourceUsageDtoWrapper parameters

eter t Value
Resour ARRAY For details, see Table Resource -

ceUsag _REFER 1-214. Usage
eList ENCE

iMaster NCE-Fabric
Table 1-214 StaticResourceUsageDto parameters

eter t Value
name string - - StaticResource -

name
resourc int32 - - ResourceNum -

eSum
resourc int32 - - ResourceUsage -

eUsag Num
e
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.9 Query Node Relations
Typical Scenarios
Query Node Relations.
Functions
Query node relations.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/node-relations

descrip Yes string 1 to - Device group "mdc"

tion 255 service
charac description.
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/fabricresource/node-relations?description=mdc HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-216 NodeRelationListWrapper parameters

eter t Value
inUse boolea - false Whether the false

n node is in the
inUse state.
nodeR ARRAY For details, see Table Node -

elation _REFER 1-217. association
List ENCE information.

iMaster NCE-Fabric
Table 1-217 NodeRelationDto parameters

eter t Value
id string 1 to 128 - nodeRelation "DBB702C3-77

characters. ID 19-4FE6-
A5AD-3A9C9E2
65309-
DBB702C3-771
9-4FE6-
A5AD-3A9C9E2
65309"
nodeId string 0 to 256 - node ID "DBB702C3-77

A5AD-3A9C9E2
65309"
fabricI string 0 to 256 - Fabric ID "DBB702C3-77

A5AD-3A9C9E2
65309"
descrip string 0 to 255 - Node relation "10"

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"inUse" : false,
"nodeRelationList" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309-DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"nodeId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.3.2.10 Update Node Relations
Typical Scenarios
The inUse state of node relations needs to be updated.
Functions
Update node relations.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/physicalnetwork/fabricresource/node-relations
Request Parameters

er Range Value on
input REFERE For details, see Table Device -

NCE 1-219. group to
be set to
the inUse
state.
Table 1-219 NodeRelationListWrapper parameters

inUse Yes boolea - false Whether the false

n node is in the
inUse state.

iMaster NCE-Fabric

nodeR Yes ARRAY For details, see Node -

elation _REFER Table 1-220. association
List ENCE information.
Table 1-220 NodeRelationDto parameters

id Yes string 1 to - nodeRelation "DBB702C3-77

128 ID 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309-
DBB702C3-771
9-4FE6-
A5AD-3A9C9E2
65309"
nodeId No string 0 to - node ID "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
fabricI No string 0 to - Fabric ID "DBB702C3-77

d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
descrip No string 0 to - Node relation "10"

charac
ters.
Sample Request
HTTP
PUT /controller/dc/v3/physicalnetwork/fabricresource/node-relations HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"inUse" : false,
{

iMaster NCE-Fabric
}
]
}
Response Parameters
NodeRelationListWrapper parameters, For details, see Table 1-216.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"inUse" : false,
{
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.11 Add a Device Group to a Fabric
Typical Scenarios
A device group needs to be added to a fabric.
Functions
Add a device group to the fabric.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabricnode
Request Parameters

er Range Value on
input REFERE For details, see Table Model of -

NCE 1-222. input
paramete
rs for
fabric
device
group
informati
on.
Table 1-222 NodesRestfulDtoWrapper parameters

node Yes REFER For details, see Fabric node -

ENCE Table 1-223. information.
Table 1-223 NodeDto parameters

fabricI Yes string 0 to - Fabric ID "00278832-000

d 256 0-0000-0000-1
charac 00000000001"
ters.

iMaster NCE-Fabric

nodeId Yes array< Each - Node ID ["56A4E7F5-

s string> item information. F912-4657-8ED
has 0 3-
to 255 D397144A89D
charac 9","9AC3A545-
ters. B4DB-4879-84
7F-3645B809E2
65"]
nodeR Yes ARRAY For details, see Node Roles -

oles _REFER Table 1-224.
ENCE
Table 1-224 NodeRole parameters

nodeId Yes string 0 to - Node ID "00278832-000

256 0-0000-0000-2
charac 00000000001"
ters.
nodeR Yes string 1 to - Node Rule "Egress

ole 255 Gateway"
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/fabricresource/fabricnode HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"node" : {
"fabricId" : "00278832-0000-0000-0000-100000000001",
"nodeIds" : ["56A4E7F5-F912-4657-8ED3-D397144A89D9","9AC3A545-
B4DB-4879-847F-3645B809E265"],
"nodeRoles" : [
{
"nodeId" : "00278832-0000-0000-0000-200000000001",
"nodeRole" : "Egress Gateway"
}
]
}
}

iMaster NCE-Fabric
Response Parameters
Table 1-225 NodesResultDtoWrapper parameters

eter t Value
nodeR ARRAY For details, see Table Node Result -

esult _REFER 1-226.
ENCE
Table 1-226 NodeResultDto parameters

eter t Value
nodeId string 0 to 256 - Node ID "00278832-000

characters. 0-0000-0000-2
00000000001"
errorC string 0 to 255 - Error Code -

ode characters.
errorM array< Each item has 0 - Error Message -

essage string> to 255
characters.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"nodeResult" : [
{
"nodeId" : "00278832-0000-0000-0000-200000000001"
}
]
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.12 Remove a Device Group from a Fabric
Typical Scenarios
A device group needs to be removed from a fabric.
Functions
Remove a device group from a fabric.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabricnode
Request Parameters

er Range Value on

NCE 1-222. input
paramete
rs for
fabric
device
group
informati
on.
Sample Request
HTTP
DELETE /controller/dc/v3/physicalnetwork/fabricresource/fabricnode HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"node" : {
"fabricId" : "00278832-0000-0000-0000-100000000001",
"nodeIds" : ["56A4E7F5-F912-4657-8ED3-D397144A89D9","9AC3A545-
B4DB-4879-847F-3645B809E265"],
"nodeRoles" : [
{
"nodeId" : "00278832-0000-0000-0000-200000000001",
"nodeRole" : "Egress Gateway"
}
]
}
}
Response Parameters
NodesResultDtoWrapper parameters, For details, see Table 1-225.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"nodeResult" : [
{
"nodeId" : "00278832-0000-0000-0000-200000000001"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.2.13 Query Fabric Node Information
Typical Scenarios
Fabric node information needs to be queried.

iMaster NCE-Fabric
Functions
Query fabric node information.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/fabricnode/{id}


256 a logical port. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"


ze 255
charac
ters.
pageIn No string 0 to - Current page "1"

dex 255 number.
charac
ters.
flag No string 0 to - Flag platform. "1"

255
charac
ters.
keywor No string 0 to - Keyword. "acl1"

d 255
charac
ters.

iMaster NCE-Fabric

nodety No string 0 to - Node type. "5"

pe 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/fabricresource/fabricnode/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309?pageSize=10&pageIndex=1&flag=1&keyword=acl1&nodetype=5 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-230 NodesByFabricIdListRestfulDtoWrapper parameters

eter t Value
fabricn ARRAY For details, see Table Fabric Node -

ode _REFER 1-231.
ENCE
total int64 [0-4000] - Number of 50

nodes on one
fabric.
totalEr int64 [0-4000] - Number of 30

ror nodes on one
fabric.

iMaster NCE-Fabric
Table 1-231 FabricNodeDto parameters

eter t Value
id string 0 to 256 - Device group "DBB702C3-77

characters. ID. This field 19-4FE6-
cannot be A5AD-3A9C9E2
updated. 65309"
nodeTy string 1 to 128 - Whether the "L2enableandl3

pe characters. device is the ewenable"
egress
gateway.
vtepIp string 0 to 255 - VTEP IP "192.168.1.1"

virtual string 1 to 128 - Virtual MAC "00:00:5E:

Mac characters. address. 00:01:01"
fabricI string 0 to 256 - Fabric ID. This "DBB702C3-77

d characters. field cannot be 19-4FE6-
updated. A5AD-3A9C9E2
65309"
vtepM string 1 to 36 - VTEP MAC "00:00:5E:

ac characters. address. 00:01:01"
enable string 1 to 128 1 Whether the "1"

nve characters. NVE capability
is available.
dciEna boolea - false Whether the -

ble n DCI gateway is
enabled. The
value is true or
false.
isSplit boolea - false Whether the -

n split horizon
capability is
supported. The
value is true
for the AL and
false for the
ML.
negrou string 0 to 256 - Device group "DBB702C3-77

pId characters. ID. 19-4FE6-
A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
group string 1 to 128 - Device group "Single"

Mode characters. type.
status string 0 to 255 - Status. "Active"

characters.
isHard string 1 to 128 - Device type. "6"

ware characters.
bgpEv string 1 to 36 - BGP EVPN "enable"

pnMod characters. mode.
e
total int32 [1-4094] - Total number 10

of records.
name string 1 to 128 CE6880 Device group "CE6880_39"

characters. _39 name.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fabricnode" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"nodeType" : "L2enableandl3ewenable",
"vtepIp" : "192.168.1.1",
"virtualMac" : "00:00:5E:00:01:01",
"vtepMac" : "00:00:5E:00:01:01",
"enablenve" : "1",
"negroupId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"groupMode" : "Single",
"status" : "Active",
"isHardware" : "6",
"bgpEvpnMode" : "enable",
"total" : 10,
"name" : "CE6880_39"
}
],
"total" : 50,
"totalError" : 30
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.3 Manage VAS Resource Pools

VAS resource pool interface description:
1. Create a VAS resource pool.
2. Query the VAS resource pool list.
3. Delete a specified VAS resource pool.
4. Modify a specified VAS resource pool.
5. Query details about a specified VAS resource pool.
6. Add a device group to a VAS resource pool.
7. Delete a device group from a VAS resource pool.
8. Query information about a device group in a specified VAS resource pool
1.9.3.3.1 Create a VAS Resource Pool
Typical Scenarios
A VAS resource pool needs to be created.
Functions
A VAS resource pool needs to be created.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/vaspool/

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-233. paramete
r for
creating a
VAS
resource
pool.
Table 1-233 VasPoolDtoWrapper parameters

vasPoo Yes ARRAY For details, see Parameter of -

lDto _REFER Table 1-234. the VAS
ENCE resource pool.

iMaster NCE-Fabric
Table 1-234 VasPoolDto parameters

id Yes string 36 - ID of a VAS "DBB702C3-77

charac resource pool. 19-4FE6-
ters. This parameter A5AD-3A9C9E2
The is mandatory 65309"
value for updating a
must VAS resource
meet pool. The value
the cannot be
followi changed.
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name Yes string 1 to - VAS resource "vaspool0"

255 pool name.
charac
ters.
descrip No string 0 to - Description of "This is a VAS

tion 255 the VAS resource pool."
charac resource pool.
ters. The value can
be changed.
interna No string ● vlan - Internal -

lInterfa if interface type,
ceMod which can be a
e ● subi
f VLAN interface
or sub-
interface.

iMaster NCE-Fabric

extern No string ● vlan - Type of an -

alInter if external
faceM interface,
ode ● subi
f which can be a
VLAN interface,
● mai sub-interface,
n or main
interface.
vasTyp Yes string ● un - Resource pool "unmanaged-

e ma type. The value firewall"
nag can be
ed- unmanaged
fire firewall, F5 LB,
wall Check Point
● f5- firewall, Palo
loa Alto firewall,
dba Fortinet
lanc firewall, or
e unmanaged
WAF.
● cp-
fire
wall
● pa-
fire
wall
● ft-
fire
wall
● un
ma
nag
ed-
waf

iMaster NCE-Fabric

networ No string ● in- - Network mode -

kingM line (inline or
ode - bypass).
depl
oy
me
nt
● off-
line
-
depl
oy
me
nt
resAllo No string ● leas - Resource -

catedP t- allocation
olicy nod policy, which
e can be
● aver Random or
- Load
nod Balancing.
e
● ran
do
m
southN No string ● den - Default policy -

orthDe y for north-south
faultAc traffic, which
tion ● per
mit can be permit
or deny.
device No ARRAY For details, see Device quota. -

Quota _REFER Table 1-235.
ENCE

iMaster NCE-Fabric
Table 1-235 DeviceResourceQuota parameters

type No string ● vsys - Resource type. -

● ban
dwi
dth
● sess
ion
● poli
cy
● floa
ting
ip
● ipse
c-
con
nect
ion
● slb
● sslv
pn
● dhc
p
● rd
● vd
● sg
quota No int32 [0-214 - Percentage of 0

74836 total resources.
47]
recover No int32 [0-214 - Recovery 0

yThres 74836 threshold.
hold 47]
alarmT No int32 [0-214 - Alarm 10

hresho 74836 threshold.
ld 47]
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/vaspool HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
{
"vasPoolDto" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "vaspool0",
"description" : "This is a VAS resource pool.",
"vasType" : "unmanaged-firewall",
"deviceQuota" : [
{
"quota" : 0,
"recoveryThreshold" : 0,
"alarmThreshold" : 10
}
]
}
]
}
Response Parameters
Table 1-236 VasPoolDtoWrapper parameters

eter t Value
vasPoo ARRAY For details, see Table Parameter of -

lDto _REFER 1-237. the VAS
ENCE resource pool.
Table 1-237 VasPoolDto parameters

eter t Value
id string 36 characters. - ID of a VAS "DBB702C3-77

The value must resource pool. 19-4FE6-
meet the This parameter A5AD-3A9C9E2
following is mandatory 65309"
regular for updating a
expression: VAS resource
[0-9a-fA-F]{8}- pool. The value
[0-9a-fA-F]{4}- cannot be
[0-9a-fA-F]{4}- changed.
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - VAS resource "vaspool0"

characters. pool name.

iMaster NCE-Fabric

eter t Value
descrip string 0 to 255 - Description of "This is a VAS

tion characters. the VAS resource pool."
resource pool.
The value can
be changed.
interna string ● vlanif - Internal -

lInterfa interface type,
ceMod ● subif
which can be a
e VLAN interface
or sub-
interface.
extern string ● vlanif - Type of an -

alInter external
faceM ● subif
interface,
ode ● main which can be a
VLAN interface,
sub-interface,
or main
interface.
vasTyp string ● unmanaged- - Resource pool "unmanaged-

e firewall type. The value firewall"
● f5- can be
loadbalance unmanaged
firewall, F5 LB,
● cp-firewall Check Point
● pa-firewall firewall, Palo
● ft-firewall Alto firewall,
Fortinet
● unmanaged- firewall, or
waf unmanaged
WAF.
networ string ● in-line- - Network mode -

kingM deployment (inline or
ode bypass).
● off-line-
deployment
resAllo string ● least-node - Resource -

catedP allocation
olicy ● aver-node
policy, which
● random can be
Random or
Load
Balancing.

iMaster NCE-Fabric

eter t Value
southN string ● deny - Default policy -

orthDe for north-south
faultAc ● permit
traffic, which
tion can be permit
or deny.
device ARRAY For details, see Table Device quota. -

Quota _REFER 1-238.
ENCE
Table 1-238 DeviceResourceQuota parameters

eter t Value
type string ● vsys - Resource type. -

● bandwidth
● session
● policy
● floatingip
● ipsec-
connection
● slb
● sslvpn
● dhcp
● rd
● vd
● sg
quota int32 [0-2147483647 - Percentage of 0

] total resources.
recover int32 [0-2147483647 - Recovery 0

yThres ] threshold.
hold
alarmT int32 [0-2147483647 - Alarm 10

hresho ] threshold.
ld

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vasPoolDto" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceQuota" : [
{
"quota" : 0,
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.3.2 Query the VAS Resource Pool List
Typical Scenarios
The list of VAS resource pools needs to be queried.
Functions
The VAS resource pool list needs to be queried.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/vaspool/

iMaster NCE-Fabric


dex 21474
83647
charac
ters.

ze 4000
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/vaspool?pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-240 VasPoolPagedDtoWrapper parameters

eter t Value
vasPoo ARRAY For details, see Table Resource pool -

lDtos _REFER 1-237. list.
ENCE

um ] of queried VAS
resource pools.
pageIn int32 [1-4000] - Page index. 10

dex
pageSi int32 [1-4000] - Page size. 10

ze

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vasPoolDtos" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceQuota" : [
{
"quota" : 0,
}
]
}
],
"totalNum" : 200,
"pageIndex" : 10,
"pageSize" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.3.3 Query Details About a Specified VAS Resource Pool
Typical Scenarios
Details about a specified VAS resource pool need to be queried.
Functions
Details about a specified VAS resource pool need to be queried.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/vaspool/{id}

id Yes string 36 - ID used for the "DBB702C3-77

charac query. 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/vaspool/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
VasPoolDtoWrapper parameters, For details, see Table 1-236.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vasPoolDto" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceQuota" : [
{
"quota" : 0,
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.3.4 Modify a Specified VAS Resource Pool
Typical Scenarios
A specified VAS resource pool needs to be updated.
Functions
A specified VAS resource pool needs to be updated.

iMaster NCE-Fabric
Constraints
HTTP Method
PUT
URI

id Yes string 36 - Update a VAS "DBB702C3-77

ters. by ID. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-233. input
paramete
rs for
updating
a VAS
resource
pool.
Sample Request
HTTP
PUT /controller/dc/v3/physicalnetwork/vaspool/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vasPoolDto" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceQuota" : [
{
"quota" : 0,
}
]
}
]
}
Response Parameters
VasPoolDtoWrapper parameters, For details, see Table 1-236.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vasPoolDto" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceQuota" : [
{
"quota" : 0,
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.3.5 Delete a Specified VAS Resource Pool
Typical Scenarios
A specified VAS resource pool needs to be deleted.
Functions
A specified VAS resource pool needs to be deleted.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric

id Yes string 36 - ID of the VAS "DBB702C3-77

ters. to be deleted. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/physicalnetwork/vaspool/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.3.6 Add Device Groups to a VAS Resource Pool
Typical Scenarios
Device groups need to be added to a VAS resource pool.
Functions
Device groups need to be added to the VAS resource pool.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/vaspool/add-node

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-246. paramete
r for
adding a
device
group to
the VAS
resource
pool.
Table 1-246 AddNodeToVasPoolDtoWrapper parameters

neGro No array< - - Device group -

upIds string> ID.
id No string - - ID of the VAS -

resource pool.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/vaspool/add-node HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.3.7 Delete a Device Group from a VAS Resource Pool
Typical Scenarios
A device group needs to be deleted from the VAS resource pool.
Functions
Device groups need to be deleted from the VAS resource pool.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/vaspool/delete-node

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-248. paramete
r for
deleting a
device
group
from a
VAS
resource
pool.
Table 1-248 DeleteNodeFromVasPoolDtoWrapper parameters

neGro No array< - - Device group -

upIds string> ID.
id No string - - ID of the VAS -

resource pool.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/vaspool/delete-node HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.3.8 Query Information About Device Groups in a Specified VAS Resource Pool
Typical Scenarios
Information about device groups in a specified VAS resource pool needs to be
queried.
Functions
Information about device groups in a specified VAS resource pool needs to be
queried.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/vaspool/{id}/node

iMaster NCE-Fabric

id Yes string 36 - ID of the VAS "DBB702C3-77

ters. to be queried. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/vaspool/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/node HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-250 QueryVasNodeDtoWrapper parameters

eter t Value
queryV ARRAY For details, see Table Parameter for -

asNod _REFER 1-251. querying device
eDto ENCE groups in a
VAS resource
pool.
Table 1-251 QueryVasNodeDto parameters

eter t Value
neGro string - - Device group -

upIds ID.
name string - - Device group -

name.
group string - - Device group -

Mode type.
neIds array< - - Device IP -

string> address list.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.3.4 Relationship between Fabric and VAS
1.9.3.4.1 Query Fabric-VAS Mappings by VAS Pool ID
Typical Scenarios
Fabric VAS mappings need to be queried.
Functions
Query fabric-VAS mappings by VAS pool ID.
Constraints
Single-interface performance: ≤ 3600s.
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/fabricvas/by/vaspool/{id}

id Yes UUID - - VAS pool ID. "CBB702C3-77

19-4FE6-
A5AD-3A9C9E2
65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/fabricvas/by/vaspool/CBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-253 FabricVasMappingDto parameters

eter t Value
id string - - Fabric-VAS "CCB702C3-77

mapping ID. 19-4FE6-
A5AD-3A9C9E2
65309"
fabricI string - - Fabric ID. "CCB702C3-77

d 19-4FE6-
A5AD-3A9C9E2
65309"
vaspoo string - - VAS pool ID. "CCB702C3-77

lId 19-4FE6-
A5AD-3A9C9E2
65309"
vaspoo string - - VAS pool type. "Firewall"

lType
vaspoo string - - VAS pool "vaspoll1"

lName name.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fabricId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vaspoolId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vaspoolType" : "Firewall",
"vaspoolName" : "vaspoll1"
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.4.2 Query Fabric VAS Mappings Based on the Fabric ID List
Typical Scenarios
Fabric VAS mappings need to be queried.
Functions
Query fabric VAS mappings based on the fabric ID list.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/servicenetwork/fabricvas/by/fabricIds
Request Parameters

VAS Yes REFER For details, see Input -

pool ENCE Table 1-255. parameter for
object querying a VAS
to pool.
query

iMaster NCE-Fabric
Table 1-255 FabricVasMappingQueryDto parameters

fabricI Yes array< - - - -

ds string>
vaspoo No string - - VAS pool "vaspoll1"

lName name.
pageIn No int32 - - Page index. 1

dex
pageSi No int32 - - Page size. 4000

ze
queryV No string - - Fuzzy query "vaspool1"

alue keyword:
queryValue.
order No string - - Order. "asc or desc"
Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/fabricvas/by/fabricIds HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"fabricIds" : [
"CBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"vaspoolName" : "vaspoll1",
"pageIndex" : 1,
"pageSize" : 4000,
"queryValue" : "vaspool1",
"order" : "asc or desc"
}
Response Parameters

iMaster NCE-Fabric
Table 1-256 FabricVasMappingDtoWrapper parameters

eter t Value
fabricV ARRAY For details, see Table - -

asMap _REFER 1-253.
pings ENCE
totalN int64 - - Total number 10

um of results.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fabricVasMappings" : [
{
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fabricId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vaspoolId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vaspoolType" : "Firewall",
"vaspoolName" : "vaspoll1"
}
],
"totalNum" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.5 Host Link
1.9.3.5.1 Import Host Access Links in a Batch
Typical Scenarios
A third-party system needs to import host links.

iMaster NCE-Fabric
Functions
Import host access links in a batch.
Constraints
None.
HTTP Method
POST
URI
/controller/platform/v1/basetopo/host-link-mgr/action/import
Request Parameters

import Yes REFER For details, see Importing host -

HostLi ENCE Table 1-258. access link
nkInpu information.
t
Table 1-258 ImportHostLinkInput parameters

hostLin No For details, see - -

kInput Table 1-259.
List
Table 1-259 hostLinkInputList parameters

deviceI No string 1 to 32 - Device IP "10.1.1.1"

p charac address.
ters.

iMaster NCE-Fabric

device No string 1 to 64 - Device port "Ethernet0/1/8

Port charac number. "
ters.
hostId No string 1 to - Host ID. "huawei1"

128
charac
ters.
hostM No string 0 to 32 - Host MAC "FA:16:3E:CF:

ac charac address. 1D:66"
ters.
provid No string 0 to - Vendor "network1"

erNet 254 network.
work charac
ters.
Sample Request
HTTP
POST /controller/platform/v1/basetopo/host-link-mgr/action/import HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"hostLinkInputList" : [
{
"deviceIp" : "10.1.1.1",
"devicePort" : "Ethernet0/1/8",
"hostId" : "huawei1",
"hostMac" : "FA:16:3E:CF:1D:66",
"providerNetwork" : "network1"
}
]
}
Response Parameters
Table 1-260 ImportHostLinkOutput parameters

eter t Value
failedLi For details, see Table - -

nkList 1-261.

iMaster NCE-Fabric
Table 1-261 failedLinkList parameters

eter t Value
deviceI string 1 to 32 - Device IP "10.1.1.1"

device string 1 to 64 - Device port "Ethernet0/1/8

Port characters. number. "
hostId string 1 to 128 - Host ID. "huawei1"

characters.
hostM string 0 to 32 - Host MAC "FA:16:3E:CF:

ac characters. address. 1D:66"
failedR string - - Cause for the "Device ip is

eason failure to not exist"
import the
inter-device
link.
provid string 0 to 254 - Vendor "network1"

erNet characters. network.
work
Sample Response
HTTP/1.1 200 OK
Date: Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
{
"failedLinkList" : [
{
"deviceIp" : "10.1.1.1",
"devicePort" : "Ethernet0/1/8",
"hostId" : "huawei1",
"hostMac" : "FA:16:3E:CF:1D:66",
"failedReason" : "Device ip is not exist",
"providerNetwork" : "network1"
}
]
}

iMaster NCE-Fabric
1.9.3.5.2 Delete Host Access Links in a Batch
Typical Scenarios
A third-party system needs to delete host links.
Functions
Delete host access links in a batch.
Constraints
None.
HTTP Method
POST
URI
/restconf/operations/huawei-ac-net-l2link:delete-host-link
Request Parameters

delete Yes REFER For details, see Deleting the -

HostLi ENCE Table2 host link list.
nkInpu DeleteHostLinkI
t nput
parameters.
Table 1-263 DeleteHostLinkInput parameters

huawei No REFER For details, see - -

-ac- ENCE Table 1-264.
net-
l2link:i
nput

iMaster NCE-Fabric
Table 1-264 DeleteHostLinks parameters

delete- No ARRAY For details, see - -

host- _REFER Table 1-265.
links ENCE
Table 1-265 HostLinkInfo parameters

host- No string 0 to 32 - Host MAC "FA:16:3E:CF:

mac charac address. 1D:66"
ters.
device- No string 1 to 64 - Device port "Ethernet0/1/8

port charac number. "
ters.
host- No string 1 to - host name "huawei1"

name 128
charac
ters.
device- No string - - Device IP "10.1.1.1"

ip address.
Sample Request
cURL
Language: en-US' -H 'X-ACCESS-TOKEN: x-
bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/restconf/operations/huawei-ac-net-
l2link:delete-host-link' -d '{
"huawei-ac-net-l2link:input" : {
"delete-host-links" : [
{
"host-mac" : "FA:16:3E:CF:1D:66",
"device-port" : "Ethernet0/1/8",
"host-name" : "huawei1",
"device-ip" : "10.1.1.1"
}
]
}
}'
HTTP
POST /restconf/operations/huawei-ac-net-l2link:delete-host-link HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"delete-host-links" : [
{
"host-mac" : "FA:16:3E:CF:1D:66",
"device-ip" : "10.1.1.1"
}
]
}
}
Response Parameters
Table 1-266 DeleteHostLinkOutput parameters

eter t Value
huawei REFER For details, see Table - -

-ac- ENCE 1-267.
net-
l2link:o
utput
Table 1-267 FailedHostLinks parameters

eter t Value
failed- For details, see Table - -

host- 1-268.
links
Table 1-268 failed-host-links parameters

eter t Value
host- string 0 to 32 - Host MAC "FA:16:3E:CF:

mac characters. address. 1D:66"

iMaster NCE-Fabric

eter t Value
device- string 1 to 64 - Device port "Ethernet0/1/8

port characters. number. "
host- string 1 to 128 - host name "huawei1"

name characters.
device- string - - Device IP "10.1.1.1"

ip address.
failed- string - - Cause for the "Local deivce ip

reason failure to is invalid"
delete the host
access link.
Sample Response
HTTP/10.1.1.111111 OK
Date: Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
{
"huawei-ac-net-l2link:output" : {
"failed-host-links" : [
{
"host-mac" : "FA:16:3E:CF:1D:66",
"device-ip" : "10.1.1.1",
"failed-reason" : "Local deivce ip is invalid"
}
]
}
}
1.9.3.6 Device Link
1.9.3.6.1 Import Inter-Device Links in a Batch
Typical Scenarios
A third-party system needs to import inter-device links.
Functions
Import inter-device links in a batch.

iMaster NCE-Fabric
Constraints
None.
HTTP Method
POST
URI
/restconf/operations/huawei-ac-net-l2link:import-device-link
Request Parameters

import Yes REFER For details, see Importing the -

Device ENCE Table 1-270. inter-device
LinkIut link list.
put
Table 1-270 ImportDeviceLinkInput parameters


net-
l2link:i
nput
Table 1-271 ImportDeviceLinks parameters

import No For details, see - -

- Table 1-272.
device-
links

iMaster NCE-Fabric
Table 1-272 import-device-links parameters

local- No string 0 to - Local "10.1.1.1"

manag 254 management
e-ip charac IP.
ters.
local- No string 1 to 64 - Local port "Ethernet0/1/8

ltp- charac name. "
port ters.
peer- No string 0 to - Peer device "DTB"

device- 246 name (edge
name charac device,
ters. mandatory)
peer-id No string - - Peer ID, which "10.1.1.2"

is an IP or MAC
address.
peer- No string ● ip - Peer ID type, "ip"

id-type which is an IP
● mac
or MAC
address.
peer- No string 1 to 64 - Peer port "Ethernet0/1/5

ltp- charac name. "
port ters.
provid No string 0 to - Vendor "network1"

er- 254 network.
networ charac
k ters.
Sample Request
cURL
l2link:import-device-link' -d '{
"import-device-links" : [
{
"local-manage-ip" : "10.1.1.1",
"local-ltp-port" : "Ethernet0/1/8",
"peer-device-name" : "DTB",
"peer-id" : "10.1.1.2",
"peer-id-type" : "ip",
"peer-ltp-port" : "Ethernet0/1/5",
"provider-network" : "network1"

iMaster NCE-Fabric
}
]
}
}'
HTTP
POST /restconf/operations/huawei-ac-net-l2link:import-device-link HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"import-device-links" : [
{
"peer-id" : "10.1.1.2",
}
]
}
}
Response Parameters
Table 1-273 ImportDeviceLinkOutput parameters

eter t Value

-ac- ENCE 1-274.
net-
l2link:o
utput
Table 1-274 ImportFailedLinks parameters

eter t Value
import For details, see Table - -

- 1-275.
failed-
links

iMaster NCE-Fabric
Table 1-275 import-failed-links parameters

eter t Value
local- string 0 to 254 - Local "10.1.1.1"

manag characters. management
e-ip IP.
local- string 1 to 64 - Local port "Ethernet0/1/8

ltp- characters. name. "
port
peer- string 0 to 246 - Peer device "DTB"

device- characters. name (edge
name device,
mandatory)
peer-id string - - Peer ID, which "10.1.1.2"

is an IP or MAC
address.
peer- string ● ip - Peer ID type, "ip"

● mac
or MAC
address.
peer- string 1 to 64 - Peer port "Ethernet0/1/5

port
failed- string - - Cause for the "The ip format

reason failure to is invalid"
import the
inter-device
link.
provid string 0 to 254 - Vendor "network1"

er- characters. network.
networ
k
Sample Response
HTTP/10.1.1.22OK10.1.1.1111111
Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
{

iMaster NCE-Fabric
"import-failed-links" : [
{
"peer-id" : "10.1.1.2",
"failed-reason" : "The ip format is invalid",
}
]
}
}
1.9.3.6.2 Delete Inter-Device Links in a Batch
Typical Scenarios
A third-party system needs to delete inter-device links.
Functions
Delete inter-device links in a batch.
Constraints
None.
HTTP Method
POST
URI
/restconf/operations/huawei-ac-net-l2link:delete-device-link
Request Parameters

delete Yes REFER For details, see Deleting the -

Device ENCE Table 1-277. inter-device
LinkIn link list.
put

iMaster NCE-Fabric
Table 1-277 DeleteDeviceLinkInput parameters


net-
l2link:i
nput
Table 1-278 DeleteDeviceLinks parameters

delete- No ARRAY For details, see - -

device- _REFER Table 1-279.
links ENCE
Table 1-279 DeviceLinkInfo parameters

local- No string 0 to - Local "10.1.1.1"

manag 254 management
e-ip charac IP.
ters.
local- No string 1 to 64 - Local port "Ethernet0/1/8

ltp- charac name. "
port ters.
peer- No string 0 to - Peer device "DTB"

device- 246 name (edge
name charac device,
ters. mandatory)
peer-id No string - - Peer ID, which "10.1.1.2"

is an IP or MAC
address.
peer- No string ● ip - Peer ID type, "ip"

● mac
or MAC
address.

iMaster NCE-Fabric

peer- No string 1 to 64 - Peer port "Ethernet0/1/5

ltp- charac name. "
port ters.
Sample Request
cURL
l2link:delete-device-link' -d '{
"delete-device-links" : [
{
"peer-id" : "10.1.1.2",
"peer-ltp-port" : "Ethernet0/1/5"
}
]
}
}'
HTTP
POST /restconf/operations/huawei-ac-net-l2link:delete-device-link HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"delete-device-links" : [
{
"peer-id" : "10.1.1.2",
"peer-ltp-port" : "Ethernet0/1/5"
}
]
}
}
Response Parameters

iMaster NCE-Fabric
Table 1-280 DeleteDeviceLinkOutput parameters

eter t Value

-ac- ENCE 1-281.
net-
l2link:o
utput
Table 1-281 FailedDeviceLinks parameters

eter t Value
failed- For details, see Table - -

device- 1-282.
links
Table 1-282 failed-device-links parameters

eter t Value
local- string 0 to 254 - Local "10.1.1.1"

manag characters. management
e-ip IP.
local- string 1 to 64 - Local port "Ethernet0/1/8

port
peer- string 0 to 246 - Peer device "DTB"

device- characters. name (edge
name device,
mandatory)
peer-id string - - Peer ID, which "10.1.1.2"

is an IP or MAC
address.
peer- string ● ip - Peer ID type, "ip"

● mac
or MAC
address.

iMaster NCE-Fabric

eter t Value
peer- string 1 to 64 - Peer port "Ethernet0/1/5

port
failed- string - - Cause for the "Local device

reason failure to info is invalid"
delete the
inter-device
link.
Sample Response
HTTP/10.1.1.22OK10.1.1.1111
Tue,30 Oct 2018 10:00:00 GMT
Content-Length: 250
{
"failed-device-links" : [
{
"peer-id" : "10.1.1.2",
"failed-reason" : "Local device info is invalid"
}
]
}
}
1.9.3.7 Open API for Device Discovery

## API description:
1. Modify the SNMP password.
2. Automatic discover devices
3. Query discovered devices based on keywords.
4. Add devices.
(Note: 1. The northbound NETCONF password needs to be changed. If the

password is different from the device password, the device connection cannot be
established and the device status is abnormal. After the password is changed to be
the same as the device password, the device connection can be established after 3
to 5 minutes and the device status is normal. 2. By default, the password of a new
northbound user cannot be changed within 10 days. To change the password of a

iMaster NCE-Fabric
northbound user, log in to the NCE management plane and choose System >
System Security > Security Policies from the main menu. On the displayed page,
choose Password Policy from the navigation pane, deselect Min. password usage
period (days), and click Apply.)
Interface SLA: (special design for special interfaces)

SLAs for query APIs
Request success rate: ≥ 99%
Availability: Tier 1
Data consistency: Strong consistency
Throughput: 200 TPS
TP50 request delay: 50 ms
TP99.9 request delay: 100 ms
1.9.3.7.1 Modify an SNMP Account
Typical Scenarios
The SNMP protocol needs to be changed for a device.
Functions
A device group needs to be added to an SNMP resource pool.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/device/snmp

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-284. paramete
r model
for the
SNMP
protocol.
Table 1-284 UserSnmpWrapper parameters

manag Yes array< Each - Device -

erIp string> item management
has 1 IP address list.
to 100
charac
ters.
snmpP Yes REFER For details, see SNMP entity -

aram ENCE Table 1-285. parameters.
Table 1-285 SnmpParamWrapper parameters

snmpV No string 1 to v3 SNMP protocol. "v3"

ersion 255 By default,
charac SNMPv3 is
ters. used.

iMaster NCE-Fabric

authPr Yes string ● NO - Authentication "HMAC_MD5"

otocol NE protocol. The
● HM value can be
AC_ HMAC_SHA,
SHA HMAC_MD5,
HMAC_SHA2_2
● HM 56,
AC_ HMAC_SHA2_3
MD 84, and
5 HMAC_SHA2_5
● HM 12.
AC_
SHA
2_2
56
● HM
AC_
SHA
2_3
84
● HM
AC_
SHA
2_5
12
authPa Yes passw 1 to - This field may "*******"

ssword ord 255 contain
charac sensitive or
Keep it secure.
Authentication
key.
privacy Yes string ● NO - Encryption "AES_128"

Protoc NE algorithm. The
ol value can be
● CBC
_DE CBC_DES,
S AES_128, or
AES_256.
● AES
_12
8
● AES
_25
6

iMaster NCE-Fabric

encryp Yes passw 1 to - This field may "*******"

tionPa ord 255 contain
ssword charac sensitive or
Keep it secure.
Encryption key.
userna Yes string 1 to - User name. "Huawei@456"

me 255
charac
ters.
port Yes int32 [1-655 - SNMP port 161

35] number, in the
range from 1
to 65535.
timeou No int32 - 15000 Timeout 15000

tPeriod interval (≥
3000). The
default value is
15000 ms.
retries No int32 [0-255 3 Number of 3

] retry times, in
the range from
0 to 255. The
default value is
3.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/device/snmp HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"managerIp" : [
"192.168.0.0"
],
"snmpParam" : {
"snmpVersion" : "v3",
"authProtocol" : "HMAC_MD5",
"authPassword" : "*******",
"privacyProtocol" : "AES_128",
"encryptionPassword" : "*******",
"username" : "Huawei@456",
"port" : 161,

iMaster NCE-Fabric
"timeoutPeriod" : 15000,
"retries" : 3
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.7.2 Automatically Discover Devices
Typical Scenarios
Devices need to be automatically discovered.
Functions
Automatically discover devices.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/device/discover/start

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table DeviceDis -

NCE 1-287. coverInpu
tDto
Table 1-287 DeviceDiscoverInputDto parameters

ipSegP Yes ARRAY For details, see IP address -

aramD _REFER Table 1-288. segment.
toList ENCE
snmpP Yes REFER For details, see SNMP -

aramD ENCE Table 1-285. parameter.
to
netcon Yes REFER For details, see NETCONF -

fParam ENCE Table 1-289. parameters.
Dto
Table 1-288 IpSegParamWrapper parameters

startIp Yes string 1 to - Start IP "192.168.0.0"

255 address.
charac
ters.
endIp Yes string 1 to - End IP address. "192.168.0.1"

255
charac
ters.

iMaster NCE-Fabric
Table 1-289 NetconfParamWrapper parameters

ncPort No int32 1 to 32 22 NETCONF port 22

charac number, which
ters. is set to 22 by
default.
ncUser Yes string 1 to - NETCONF "custom"

Name 255 username.
charac
ters.
ncKey Yes passw 1 to - This field may "*******"

ord 255 contain
charac sensitive or
Keep it secure.
NETCONF
password.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/device/discover/start HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"ipSegParamDtoList" : [
{
"startIp" : "192.168.0.0",
"endIp" : "192.168.0.1"
}
],
"snmpParamDto" : {
"snmpVersion" : "v3",
"authProtocol" : "HMAC_MD5",
"authPassword" : "*******",
"privacyProtocol" : "AES_128",
"encryptionPassword" : "*******",
"username" : "Huawei@456",
"port" : 161,
"timeoutPeriod" : 15000,
"retries" : 3
},
"netconfParamDto" : {
"ncPort" : 22,
"ncUserName" : "custom",
"ncKey" : "*******"
}
}

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.7.3 Device Polling Progress
Typical Scenarios
Discovered devices need to be queried by keyword.
Functions
Query discovered devices based on keywords.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v3/physicalnetwork/device/discover/result


dex

ze
ascend No boolea - - Order. -

n
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/device/discover/result?pageIndex=1&pageSize=20 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-291 DeviceDiscoverResultDto parameters

eter t Value
device ARRAY For details, see Table Device name. -

List _REFER 1-292.
ENCE
totalN int64 - - Total number -

um of matched
rows.
switch int64 - - Total number -

Num of switches.

iMaster NCE-Fabric

eter t Value
firewal int64 - - Total number -

lNum of firewalls.
loadba int64 - - Total number -

lanceN of load
um balancers.
router int64 - - Total number -

Num of routers.
proces int32 - - Task progress -

s
lockErr string - - lockErrorString -

orStrin
g
linkErr string - - linkErrorIp -

orIp
linkFail string - - linkFailedIp -

edIp
Table 1-292 DiscoverDeviceSingleResult parameters

eter t Value
deviceI REFER For details, see Table Device -

nfo ENCE 1-293. information.
isSucce boolea - - Whether the -

ss n operation is
successful.
resultI string - - Result. -

nfo
added int32 - - Add the Fabric -

Status Status
added string - - Error code for -

ErrorC the failure to
ode add a device.

iMaster NCE-Fabric
Table 1-293 DeviceDto parameters

eter t Value
id string - - Device ID. -
ip string - - Device -
management
IP address.
name string - - Device name. -
device string - - Device type. -

Type
device string - - Device mode. -

Model
status int32 - - NETCONF -

status of a
device.
vendor string - - Vendor. -
contac string - - Contact -

t information.
device string - - deviceOrganiza -

Organi tionID
zationI
D
organi string - - organizationNa -

zation me
Name
descrip string - - Device -

tion description.
version string - - Device version. -
admin int32 - - Administrative -

Status status.
locatio string - - Fault location -

n information.
esn string - - esn -
mac string - - Device MAC -

address.
sysoid string - - sysoid -

iMaster NCE-Fabric

eter t Value
vpnNa string - - VPN name. -

me
softwa string - - Software -

reVersi version.
on
hardw string - - Hardware -

areVer version
sion number.
Response status code 400: Bad request.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.7.4 Add a Device
Typical Scenarios
A device needs to be added.

iMaster NCE-Fabric
Functions
Add the Default IP Address of the Device.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/device/discover/add
Request Parameters

device Yes REFER For details, see Add device -

AddInp ENCE Table 1-295. information.
ut
Table 1-295 DeviceAddInput parameters

ipList No array< - - IP address list. -

string> If this
parameter is
not set, the IP
addresses of all
queried devices
are transferred
by default.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/device/discover/add HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters

Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.7.5 Result of the Add Operation
Typical Scenarios
Added devices need to be queried.
Functions
Query the added device based on keywords.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v3/physicalnetwork/device/discover/add/result


dex

ze
ascend No boolea - - Order. -

n
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/device/discover/add/result?pageIndex=1&pageSize=20 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-297 DeviceAddResultDto parameters

eter t Value
device ARRAY For details, see Table Device name. -

List _REFER 1-298.
ENCE
totalN int64 - - Total number. -

um
switch int64 - - Total number -

Num of switches.

iMaster NCE-Fabric

eter t Value
firewal int64 - - Total number -

lNum of firewalls.
loadba int64 - - Total number -

lanceN of load
um balancers.
router int64 - - Total number -

Num of routers.
proces int32 - - Total progress. -

s
lockErr string - - lockErrorString -

orStrin
g
linkErr string - - linkErrorIp -

orIp
linkFail string - - linkFailedIp -

edIp
Table 1-298 AddDeviceSingleResult parameters

eter t Value
deviceI REFER For details, see Table Device -

added int32 - - Device adding -

Status status. The
options are as
follows: 0: not
added; 1:
added.
added string - - Error code for -

ErrorC the failure to
ode add a device.
added string - - Add Device -

ErrorM Error
sg Information

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.7.6 Add Devices
Typical Scenarios
A device needs to be added.
Functions
Add a device to the ATIC.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/device/manager/staticimport

iMaster NCE-Fabric
Request Parameters

addDe Yes REFER For details, see addParameter -

vices ENCE Table 1-300.
Table 1-300 DeviceAdd parameters

deviceI No ARRAY 0-300 items. For Device -

nfo _REFER details, see information.
ENCE Table 1-301.
Table 1-301 AddDeviceInfo parameters

device No REFER For details, see Basic device -

BasicIn ENCE Table 1-302. information.
fo
userAc No ARRAY 0-300 items. For Device -

counts _REFER details, see information
ENCE Table 1-303.

iMaster NCE-Fabric
Table 1-302 DeviceBasicInfo parameters

id No string 36 - Device ID, "7f0f98d0-

charac which uniquely daa2-4239-
ters. identifies a b838-440bd12
The device. 830b8"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
manag No string 1 to - Device "192.168.1.1"

Ip 128 management
charac IP address.
ters.
name No string 1 to - Device name. "CE6850_47.10

255 5-12.12.47.104"
charac
ters.
mac No string 0 to - Device MAC "a1:b2:c3:d4:e5:

128 address. f6"
charac
ters.
esn No string 0 to - Device ESN. "D6DB0F51499

512 4E85517180C0
charac F6585C7B5523
ters. B69CC"

iMaster NCE-Fabric

device No string 0 to - Device type. "SWITCH"

Type 128
charac
ters.
device No string 0 to - Device model. "CE6850-48S6

Model 256 Q-HI"
charac
ters.
manuf No string 0 to - Manufacturer. "HUAWEI"

acturer 512
charac
ters.
hardw No string 0 to - Hardware "CE6850-48S6

areVer 256 version. Q-HI"
sion charac
ters.
softwa No string 0 to - Software "V200R019C10

reVersi 256 version. SPC800"
on charac
ters.
Table 1-303 UserAccountInfo parameters

protoc No string ● NET - Protocol type. "NETCONF"

olType CO
NF
● TEL
NET
● SN
MP
● SSH
userNa No string 1 to - Username. "v3r1user"

me 128
charac
ters.

iMaster NCE-Fabric

passw No string 1 to - This field may -

ord 128 contain
charac sensitive or
Keep it secure.
Password.
portNu No int64 [0-655 - Port. 22

m 35]
snmpV No string 1 to - SNMP version. "V3"

ersion 255
charac
ters.
snmpA No string ● HM - SNMP "HMAC_SHA2_

uthPro AC_ authentication 256"
tocol SHA protocol.
● HM
AC_
MD
5
● HM
AC_
SHA
2_2
56
● HM
AC_
SHA
2_3
84
● HM
AC_
SHA
2_5
12
snmpA No string 1 to - This field may -

uthPas 255 contain
sword charac sensitive or
Keep it secure.
SNMP
authentication
key.

iMaster NCE-Fabric

snmpP No string ● CBC - SNMP "AES_128"

rivacyP _DE encryption
rotocol S algorithm.
● AES
_12
8
● AES
_25
6
snmpE No string 1 to - This field may -

ncrypti 255 contain
onPass charac sensitive or
word ters. personal data.
Keep it secure.
SNMP
encryption key.
snmpTi No int32 [0-150 - Timeout 15000

meout 00] interval.
Period
snmpR No int32 [1-3] - Maximum retry 3

etries times.
snmpS No string 1 to - SNMP sysoid "1.3.6.1.4.1.9.1.

ysOid 255 path. 1018"
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/device/manager/staticimport HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceInfo" : [
{
"deviceBasicInfo" : {
"id" : "7f0f98d0-daa2-4239-b838-440bd12830b8",
"managIp" : "192.168.1.1",
"name" : "CE6850_47.105-12.12.47.104",
"mac" : "a1:b2:c3:d4:e5:f6",
"esn" : "D6DB0F514994E85517180C0F6585C7B5523B69CC",
"deviceType" : "SWITCH",
"deviceModel" : "CE6850-48S6Q-HI",

iMaster NCE-Fabric
"manufacturer" : "HUAWEI",
"hardwareVersion" : "CE6850-48S6Q-HI",
"softwareVersion" : "V200R019C10SPC800"
},
"userAccounts" : [
{
"protocolType" : "NETCONF",
"userName" : "v3r1user",
"portNum" : 22,
"snmpVersion" : "V3",
"snmpAuthProtocol" : "HMAC_SHA2_256",
"snmpPrivacyProtocol" : "AES_128",
"snmpTimeoutPeriod" : 15000,
"snmpRetries" : 3,
"snmpSysOid" : "1.3.6.1.4.1.9.1.1018"
}
]
}
]
}
Response Parameters
Response status code 200: Response status code 200: OK.
Table 1-304 DeviceAddResult parameters

eter t Value
result REFER For details, see Table Addition Result -

ENCE 1-305.
Table 1-305 DeviceOperateResult parameters

eter t Value
success ARRAY 0-300 items. For details, List of devices -

List _REFER see Table 1-306. that are
ENCE successfully
operated.
failedLi ARRAY 0-300 items. For details, List of devices -

st _REFER see Table 1-307. that fail to be
ENCE operated.

iMaster NCE-Fabric
Table 1-306 SuccessInfo parameters

eter t Value
id string - - Device ID. "7f0f98d0-

daa2-4239-
b838-440bd12
830b8"
ip string - - ip "192.168.1.1"
name string - - name "CE6850_47.10

5-12.12.47.104"
Table 1-307 FailedInfo parameters

eter t Value
id string - - Device ID. "7f0f98d0-

daa2-4239-
b838-440bd12
830b8"
ip string - - ip "192.168.1.1"
mac string - - mac "00:00:5E:

00:01:01"
esn string 0 to 512 - esn "D6DB0F51499

characters. 4E85517180C0
F6585C7B5523
B69CC"
comm REFER For details, see Table Common -

onFaile ENCE 1-308. failure result.
dInfo
Table 1-308 CommonFailedInfo parameters

eter t Value
errorC string - - errorCode -

ode
errorM string - - errorMessage -

essage

iMaster NCE-Fabric
Response status code 400: Response status code 400: Bad request.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"result" : {
"successList" : [
{
"id" : "7f0f98d0-daa2-4239-b838-440bd12830b8",
"ip" : "192.168.1.1",
"name" : "CE6850_47.105-12.12.47.104"
}
],
"failedList" : [
{
"id" : "7f0f98d0-daa2-4239-b838-440bd12830b8",
"ip" : "192.168.1.1",
"mac" : "00:00:5E:00:01:01",
"esn" : "D6DB0F514994E85517180C0F6585C7B5523B69CC"
}
]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.7.7 Delete Devices
Typical Scenarios
A device needs to be deleted.
Functions
Delete a device.

iMaster NCE-Fabric
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/physicalnetwork/device/manager/delete
Request Parameters

delete Yes REFER For details, see deleteParamet -

Device ENCE Table 1-310. er
s
Table 1-310 DeviceDelete parameters

deviceI No ARRAY 0-300 items. For Device -

nfo _REFER details, see information.
ENCE Table 1-311.

iMaster NCE-Fabric
Table 1-311 DeleteDeviceInfo parameters

id No string 36 - Device ID. "7f0f98d0-

charac daa2-4239-
ters. b838-440bd12
The 830b8"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Sample Request
HTTP
DELETE /controller/dc/v3/physicalnetwork/device/manager/delete HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceInfo" : [
{
"id" : "7f0f98d0-daa2-4239-b838-440bd12830b8"
}
]
}
Response Parameters

iMaster NCE-Fabric
Table 1-312 DeviceDeleteResult parameters

eter t Value
result REFER For details, see Table Deletion result. -

ENCE 1-305.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"result" : {
"successList" : [
{
"id" : "7f0f98d0-daa2-4239-b838-440bd12830b8",
"ip" : "192.168.1.1",
"name" : "CE6850_47.105-12.12.47.104"
}
],
"failedList" : [
{
"id" : "7f0f98d0-daa2-4239-b838-440bd12830b8",
"ip" : "192.168.1.1",
"mac" : "00:00:5E:00:01:01",
"esn" : "D6DB0F514994E85517180C0F6585C7B5523B69CC"
}
]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.3.7.8 Save Authentication Information
Typical Scenarios
Authentication information needs to be saved.
Functions
Save the authentication information.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/device/protocol
Request Parameters

SaveA Yes REFER For details, see SaveAuthInfoIn -

uthInfo ENCE Table 1-314. put
Input
Table 1-314 SaveAuthInfoInput parameters

authInf No ARRAY 0-300 items. For authInfos -

os _REFER details, see
ENCE Table 1-315.

iMaster NCE-Fabric
Table 1-315 AuthInfo parameters

deviceI No string 36 - Device ID. "7f0f98d0-

d charac daa2-4239-
ters. b838-440bd12
The 830b8"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
UserAc No REFER For details, see Client -

countI ENCE Table 1-303. information.
nfo
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/device/protocol HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"authInfos" : [
{
"deviceId" : "7f0f98d0-daa2-4239-b838-440bd12830b8",
"UserAccountInfo" : {
"protocolType" : "NETCONF",
"userName" : "v3r1user",

iMaster NCE-Fabric
"portNum" : 22,
"snmpVersion" : "V3",
"snmpAuthProtocol" : "HMAC_SHA2_256",
"snmpPrivacyProtocol" : "AES_128",
"snmpTimeoutPeriod" : 15000,
"snmpRetries" : 3,
"snmpSysOid" : "1.3.6.1.4.1.9.1.1018"
}
}
]
}
Response Parameters
Table 1-316 SaveAuthInfoOutput parameters

eter t Value
saveAu ARRAY 0-300 items. For details, List of devices -

thInfoS _REFER see Table 1-317. that are
uccess ENCE successfully
List authenticated.
saveAu ARRAY 0-300 items. For details, List of devices -

thInfoF _REFER see Table 1-318. that fail to be
ailedLi ENCE authenticated.
st
Table 1-317 SaveAuthInfoSuccess parameters

eter t Value
deviceI string - - Device ID. "7f0f98d0-

d daa2-4239-
b838-440bd12
830b8"
Table 1-318 SaveAuthInfoFailed parameters

eter t Value
deviceI string - - Device ID. "7f0f98d0-

d daa2-4239-
b838-440bd12
830b8"

iMaster NCE-Fabric

eter t Value
result REFER For details, see Table Failure -

ENCE 1-308. information.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"saveAuthInfoSuccessList" : [
{
"deviceId" : "7f0f98d0-daa2-4239-b838-440bd12830b8"
}
],
"saveAuthInfoFailedList" : [
{
"deviceId" : "7f0f98d0-daa2-4239-b838-440bd12830b8"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.8 Device Groups

## Device group interface description:
1. Create a device group.
2. Delete a Device Group

iMaster NCE-Fabric
1.9.3.8.1 Create a Device Group
Typical Scenarios
A device group needs to be created.
Functions
Create a Device Group.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/device-groups
Request Parameters

er Range Value on
input REFERE For details, see Table Device -

NCE 1-320. group
object.

iMaster NCE-Fabric
Table 1-320 DeviceGroupInputDto parameters

id No string 36 - Device group "88886666-666

charac ID. 6-8888-6666-8
ters. 88866666111"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name Yes string 1 to - Device group "Leaf2"

255 name.
charac
ters.
group Yes string 1 to - Device group "active-active"

Mode 255 protection
charac mode. The
ters. value can be
single, active-
active, active-
standby, mirror,
dummy, vrrp,
or cluster.
device Yes ARRAY For details, see Member device -

_REFER Table 1-321. list.
ENCE

iMaster NCE-Fabric

deviceI No string 36 - Device group "DBB702C3-77

d charac ID. 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
device No string - - Device role. -

Role This parameter
is read-only.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/device-groups HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "88886666-6666-8888-6666-888866666111",
"name" : "Leaf2",
"groupMode" : "active-active",
"device" : [
{

iMaster NCE-Fabric
}
]
}
Response Parameters
Table 1-322 DeviceGroupOutputDto parameters

eter t Value
id string 36 characters. - Device group "DBB702C3-77

following 60001"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string - - Device group -

name.
status string - - Device group -

status. The
value can be
active, down,
or double-
master.
group string - - Device group -

Mode protection
mode. The
value can be
single, active-
active, active-
standby, mirror,
dummy, vrrp,
or cluster.

iMaster NCE-Fabric

eter t Value
groupT string - - Device group -

ype type. The
options are
firewall,
thirdparty-
firewall,
thirdparty-
loadbalance,
dhcp-compute,
dhcp-network,
switch, vswitch,
f5-loadbalance,
cp-firewall, pa-
firewall, ft-
firewall, waf,
and router.
device ARRAY For details, see Table List of device -

_REFER 1-323. group
ENCE members.

meet the device group A5AD-3A9C9E2
following belongs. 60001"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
device string - - Device type, -

Model such as
CE12800,
NE5000E,
CX600, and
USG6550.
provid string - - Provider. "Local"

er

iMaster NCE-Fabric

eter t Value
deviceI string 36 characters. - Device group "DBB702C3-77

d The value must ID. 19-4FE6-
following 60001"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
device string - - Device role. -

Role This parameter
is read-only.

Response status code 500: Failed request due to an internal service error.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
"device" : [
{
}
],
"provider" : "Local"
}

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Response status code 500: Failed request due to an internal service error.
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.8.2 Delete a Device Group
Typical Scenarios
A device group needs to be deleted.
Functions
Delete a device group. A device group that has been added to a resource pool
cannot be deleted.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/physicalnetwork/device-groups/{id}

iMaster NCE-Fabric

id Yes string 36 - Device group "DBB702C3-77

charac object ID. 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/physicalnetwork/device-groups/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.3.9 Query the Network Link List
Functions
Query network link information, including the link list, total number of device
records meeting the query condition, and total number of pages for displaying
records.
SLA item Definition
Data consistency Eventually consistent; inconsistency

duration < 1 minute
Throughput 60 tps
Constraints
This API supports access from northbound users and can be used only after a user
session has been established.
HTTP Method
GET

iMaster NCE-Fabric
URI
/rest/openapi/network/link

anedn No string 0 to - Source NE DN. "da453377-

100 eb06-11e9-8aa
charac e-
ters. d2f2c051aa41"
anena No string 0 to - Source NE "scp101"

me 255 name.
charac
ters.
aneip No string 0 to - Source NE IP "10.10.12.11"

255 address.
charac
ters.
anesta No integer ● 0 - 0: unmanaged 1

te
● 1 1: online
● 2 2: offline
● 3 3: unknown
aportd No string 0 to - Source port "2961c398-099

n 100 DN. 4-4d3c-8bdb-3
charac efa29370edf"
ters.
aportn No string 0 to - Source port "eth1"

ame 255 name.
charac
ters.
aportip No string 0 to 64 - Source port IP "10.10.13.11"

charac address.
ters.
aporta No integer ● 1 - 1: up 1
dminst
atus ● 2 2: down
● 3 3: testing

iMaster NCE-Fabric

aporto No integer ● 1 - 1: up 1
perstat
us ● 2 2: down
● 3 3: testing
● 4 4: unknown
● 5 5: dormant
● 6 6: notPresent
● 7 7:
lowerLayerDow
n
znedn No string 0 to - Destination NE "sa423377-

100 DN. eb06-11e9-8aa
charac e-
ters. d2f2c051aa31"
znena No string 0 to - Destination NE "scp102"

me 255 name.
charac
ters.
zneip No string 0 to - Destination NE "10.10.12.12"

255 IP address.
charac
ters.
znestat No integer ● 0 - 0: unmanaged 1

e
● 1 1: online
● 2 2: offline
● 3 3: unknown
zportd No string 0 to - Destination "2231c398-099

n 100 port DN. 4-4d3c-8bdb-3
charac efa29370231"
ters.
zportn No string 0 to - Destination "eth2"

ame 255 port name.
charac
ters.
zportip No string 0 to 64 - Destination "10.10.13.12"

charac port IP address.
ters.
zporta No integer ● 1 - 1: up 1
dminst
atus ● 2 2: down
● 3 3: testing

iMaster NCE-Fabric

zporto No integer ● 1 - 1: up 1
perstat
us ● 2 2: down
● 3 3: testing
● 4 4: unknown
● 5 5: dormant
● 6 6: notPresent
● 7 7:
lowerLayerDow
n
linkdn No string 0 to - Link DN. "2--151449282

255 7838740513-44
charac 985527014712
ters. 4082"
linkna No string 0 to - Link name. "1111"

me 1130
charac
ters.
linksta No integer ● 0 - Link status. 1

tus
● 1 0: normal
● 2 1: unknown
● 3 2: major fault
● 4 3: emergent
● 5 fault
● 6 4: offline
5: unmanaged
6: faulty (major
or emergent
fault)
linktyp No integer ● 1 - 1: LLDP 1

e
● 2 2: side-by-side
● 3 link
● 4 3: MACARP
● 5 4: CDP
● 6 5: IP address
● 99 6: Eth-Trunk
link generated
based on
physical links
99: manual

iMaster NCE-Fabric

speed No string 0 to 32 - The unit is "1000"

charac Mbit/s.
ters.
start No integer - 0 Start position 0

for returning
query result
sets. If the
value is smaller
than 0, the
default value is
used.
size No integer - 20 Number of 20

returned query
result sets. The
value range is
1 to 1000. The
default value is
20. Note: If the
value is smaller
than 0, the
default value is
used.
orderb No string 0 to 10 linkdn Field used to "linkdn"

y charac sort query
ters. result sets.
desc No boolea - false Whether query false

n results are
sorted in
descending
order. This
parameter is
valid only
when orderby
is set.
Request Parameters
N/A
Sample Request
cURL
curl -k -s -L -i -X GET -H 'Content-Type: application/json' -H 'Accept: application/json' -H 'Accept-Language:
en-US' -H 'X-AUTH-TOKEN: x-

iMaster NCE-Fabric
bybuqp7xmlup9htd5gpg4bmmrufvnt4aan' 'https://192.168.1.125:18002/rest/openapi/network/link?
anedn=da453377-eb06-11e9-8aae-
d2f2c051aa41&anename=scp101&aneip=10.10.12.11&anestate=1&aportdn=2961c398-0994-4d3c-8bdb-3efa
29370edf&aportname=eth1&aportip=10.10.13.11&aportadminstatus=1&aportoperstatus=1&znedn=sa423377
-eb06-11e9-8aae-
d2f2c051aa31&znename=scp102&zneip=10.10.12.12&znestate=1&zportdn=2231c398-0994-4d3c-8bdb-3efa2
9370231&zportname=eth2&zportip=10.10.13.12&zportadminstatus=1&zportoperstatus=1&linkdn=2--151449
2827838740513-449855270147124082&linkname=1111&linkstatus=1&linktype=1&speed=1000&start=0&size
=20&orderby=linkdn&desc=false'
HTTP
GET /rest/openapi/network/link?anedn=da453377-eb06-11e9-8aae-
d2f2c051aa41&anename=scp101&aneip=10.10.12.11&anestate=1&aportdn=2961c398-0994-4d3c-8bdb-3efa
29370edf&aportname=eth1&aportip=10.10.13.11&aportadminstatus=1&aportoperstatus=1&znedn=sa423377
-eb06-11e9-8aae-
d2f2c051aa31&znename=scp102&zneip=10.10.12.12&znestate=1&zportdn=2231c398-0994-4d3c-8bdb-3efa2
9370231&zportname=eth2&zportip=10.10.13.12&zportadminstatus=1&zportoperstatus=1&linkdn=2--151449
2827838740513-449855270147124082&linkname=1111&linkstatus=1&linktype=1&speed=1000&start=0&size
=20&orderby=linkdn&desc=false HTTP/1.1
Host: 192.168.1.125:18002
X-AUTH-TOKEN: x-
Response Parameters
Response status code 200: Link list.
Table 1-326 NorthResponse parameters

eter t Value
code integer - 0 Operation -

return
code.Such as
the following
value: 0:
success not 0:
failure
descrip string - - Description of -

tion the interface
call result.
data ARRAY For details, see Table Link info -

_REFER 1-327.
ENCE

iMaster NCE-Fabric
Table 1-327 LinkDataModel parameters

eter t Value
linkdn string - - Link DN. -
linkna string - - Link name. -

me
anedn string - - Source NE DN. -
anena string - - Source NE -

me name.
aneip string - - Source NE IP -

address.
anesta integer ● 0 - 0: unmanaged -

te
● 1 1: online
● 2 2: offline
● 3 3: unknown
aportd string - - Source port -

n DN.
aportn string - - Source port -

ame name.
aportip string - - Source port IP -

address.
aporta integer ● 1 - 1: up -
dminst
atus ● 2 2: down
● 3 3: testing
aporto integer ● 1 - 1: up -
perstat
us ● 2 2: down
● 3 3: testing
● 4 4: unknown
● 5 5: dormant
● 6 6: notPresent
● 7 7:
lowerLayerDow
n
znedn string - - Destination NE -

DN.

iMaster NCE-Fabric

eter t Value
znena string - - Destination NE -

me name.
zneip string - - Destination NE -

IP address.
znestat integer ● 0 - 0: unmanaged -

e
● 1 1: online
● 2 2: offline
● 3 3: unknown
zportd string - - Destination -

n port DN.
zportn string - - Destination -

ame port name.
zportip string - - Destination -

port IP address.
zporta integer ● 1 - 1: up -
dminst
atus ● 2 2: down
● 3 3: testing
zporto integer ● 1 - 1: up -
perstat
us ● 2 2: down
● 3 3: testing
● 4 4: unknown
● 5 5: dormant
● 6 6: notPresent
● 7 7:
lowerLayerDow
n
linksta integer ● 0 - 0: normal -

tus
● 1 1: unknown
● 2 2: major fault
● 3 3: emergent
● 4 fault
● 5 4: offline
5: unmanaged

iMaster NCE-Fabric

eter t Value
linktyp integer ● 1 - 1: LLDP -

e
● 2 2: side-by-side
● 3 link
● 4 3: MACARP
● 5 4: CDP
● 6 5: IP address
● 99 6: Eth-Trunk
link generated
based on
physical links
99: manual
speed string - - The unit is -

Mbit/s.
aportin string - - Source port -

dex index
zportin string - - Sink port index -

dex

Response status code 500: Internal error.
Sample Response
Response status code 200:
HTTP/1.1 200 OK
{
"code": 0,
"data":[
{
"linkdn": "2--1514492827838740513-449855270147124082",
"linkname": "1111",
"anedn": "da453377-eb06-11e9-8aae-d2f2c051aa41",
"anename": "scp101",
"aneip": "10.10.12.11",
"anestate": 1,
"aportdn": "2961c398-0994-4d3c-8bdb-3efa29370edf",
"aportname": "eth1",
"aportip": "10.10.13.11",
"aportadminstatus": 1,
"aportoperstatus": 1,
"znedn": "sa423377-eb06-11e9-8aae-d2f2c051aa31",

iMaster NCE-Fabric
"znename": "scp102",
"zneip": "10.10.12.12",
"znestate": 1,
"zportdn": "2231c398-0994-4d3c-8bdb-3efa29370231",
"zportname": "eth2",
"zportip": "10.10.13.12",
"zportadminstatus": 1,
"zportoperstatus": 1,
"linkStatus": 1,
"linktype": 1,
"speed": "1000",
"aportindex": "8",
"zportindex": "5"
}
],
"description": "Operation success"
}

application/json

application/json
1.9.3.10 Host Link Status Query

Host link status query.
1.9.3.10.1 Query Host Link Status
Typical Scenarios
The host link status needs to be queried.
Functions
Query the host link status.
Constraints
HTTP Method
POST
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/query-host-status

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table Host link -

NCE 1-329. status
entity.
Table 1-329 HostStatusRequest parameters

hosts No ARRAY 1 items. For Host -

_REFER details, see information to
ENCE Table 1-330. be requested.
Table 1-330 RequestHostsEntity parameters

host-id Yes string 1 to - Host ID. "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65339"
Sample Request
HTTP
POST /restconf/data/huawei-ac-neutron:neutron-cfg/query-host-status HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"hosts" : [
{
"host-id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265339"
}
]
}

iMaster NCE-Fabric
Response Parameters
Response status code 201: Demo Information

eter t Value
X- string - - This field is the -

reques request ID
t-id number for
task tracking.
Format is
request_uuid-
timestamp-
hostname.
Response status code 400: Error response

eter t Value
X- string - - This field is the -

reques request ID
t-id number for
task tracking.
Format is
request_uuid-
timestamp-
hostname.
Table 1-333 ErrorRsp parameters

eter t Value
error_c string 8 to 36 - Error code. -

ode characters.
error_ string 2 to 512 - Description. -

msg characters.

iMaster NCE-Fabric
Sample Response
Response status code 201: Demo Information
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
X-request-id:
Response status code 400: Error response

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
X-request-id:
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4 Public Service
1.9.4.1 Controller Resource Preconfiguration

## Controller preconfiguration APIs
1.9.4.1.1 Preconfigure the Controller
Typical Scenarios
The controller needs to be installed by the preinstallation operator.
Functions
Preconfigure the controller.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/common/preconfig

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
POST /controller/dc/v3/common/preconfig HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-334 Result parameters

eter t Value
result string 1 to 36 - Execution "Resources

characters. result. cannot be
deleted
because vni are
being
occupied."
Result parameters, For details, see Table 1-334.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"result" : "Resources cannot be deleted because vni are being occupied."
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"result" : "Resources cannot be deleted because vni are being occupied."
}
1.9.4.2 External Gateway Management

API for querying external gateways
1.9.4.2.1 Query an External Gateway
Typical Scenarios
An external gateway needs to be queried.
Functions
Query an external gateway.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/publicservice/external-gateways/external-gateway/{id}

id Yes string 0 to - External "DBB702C3-77

256 gateway ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/publicservice/external-gateways/external-gateway/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1

iMaster NCE-Fabric
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-336 ExternalGatewayRestfulDtoWrapper parameters

eter t Value
extern ARRAY For details, see Table External -

alGate _REFER 1-337. gateway
way ENCE information.
Table 1-337 ExternalGatewayDto parameters

eter t Value
id string 0 to 256 - External "DBB702C3-77

characters. gateway ID. 19-4FE6-
This field A5AD-3A9C9E2
cannot be 65309"
updated.
name string 1 to 255 - External "10"

characters. gateway name.
This field
cannot be
updated.
descrip string 0 to 255 - External "10"

tion characters. gateway
description.
This field
cannot be
updated.
gatew string 1 to 255 - External "Public"

ayType characters. gateway type,
which can be
Public or
Private. This
field cannot be
updated.

iMaster NCE-Fabric

eter t Value
publicI array< - - Public IP ["10.1.1.0/24"]

ppool string> address pool of
an external
gateway.
service array< - - List of IP ["10.1.1.1"]

Ippool string> addresses
connected to
an external
gateway.
isTelco boolea - - Telco cloud false

Gatew n gateway. This
ay field cannot be
updated.
vrfNa string 1 to 255 - VRF. This field "extgw_vrf"

me characters. cannot be
updated.
isAllSh boolea - - Whether the true

ared n field is shared
by all tenants.
This field
cannot be
updated.
fabricC ARRAY For details, see Table Fabric, which -

onfigs _REFER 1-338. cannot be
ENCE updated.
service boolea - - Whether the true

IpDefa n public service
ultPoli IP address is
cy enabled. This
parameter
cannot be
updated.
preConf boolea - - Whether it is true

igured n pre-configured.
This parameter
cannot be
updated.

iMaster NCE-Fabric

eter t Value
interfa int32 - - Configured 1

ceType egress
interface type,
which cannot
be updated.
routeE int32 - - Route export 1

xportM mode, which
odel cannot be
updated.
vpnTar string 1 to 255 - Route target, "2:2000"

get characters. which cannot
be updated.
l3Vni int32 - - L3VNI, which 1

cannot be
updated.
default int64 [1-4294967295 - External -

Tag ] gateway tag
information.
default int32 [1-255] 60 Preference -

Prefere attribute of the
nce external
gateway.
fabricV string 1 to 255 - Fabric import "2:2000"

pnTarg characters. router, which
et cannot be
updated.
device ARRAY For details, see Table Device group. -

Groups _REFER 1-339. Devices in the
ENCE list must
belong to the
same device
group. If the
logical router
type is Normal,
the value of
this parameter
must be null.
type string 1 to 255 - External "l3-share-

characters. gateway type, export"
which cannot
be updated.

iMaster NCE-Fabric

eter t Value
additio REFER For details, see Table Additional -

nal ENCE 1-340. information
class.
Table 1-338 ExternalGatewayFabricDto parameters

eter t Value
id string 1 to 255 - ID, which "DBB702C3-77

characters. cannot be 19-4FE6-
65309"

65309"
fabricR string - - Fabric role. The "master"

ole value can be
master or
backup. This
parameter
cannot be
updated.
fabric string 0 to 255 - Fabric name. "fabricName"

Name characters. This field
cannot be
updated.
Table 1-339 ExternalGatewayDeviceGroupDto parameters

eter t Value
id string 1 to 255 - ID, which "DBB702C3-77

characters. cannot be 19-4FE6-
65309"

65309"

iMaster NCE-Fabric

eter t Value

cannot be
updated.
device string 1 to 255 - Device group "DBB702C3-77

GroupI characters. ID, which 19-4FE6-
d cannot be A5AD-3A9C9E2
updated. 65309"
device string 0 to 255 - Device group "deviceGroupN

Group characters. name, which ame"
Name cannot be
updated.
deviceI string 0 to 256 - Device ID, "DBB702C3-77

d characters. which cannot 19-4FE6-
be updated. A5AD-3A9C9E2
65309"
device string 0 to 255 - Device name, "deviceName"

Name characters. which cannot
be updated.
Table 1-340 AdditionDto parameters

eter t Value
produc string 0 to 36 - Producer. This "10"

er characters. parameter is
optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
create string 0 to 255 - Creation time. "2016-03-08T2

At characters. 0:19:41.000+00:
00"

iMaster NCE-Fabric

eter t Value
update string 0 to 255 - Update time. "2016-03-08T2

00"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"externalGateway" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"description" : "10",
"gatewayType" : "Public",
"publicIppool" : ["10.1.1.0/24"],
"serviceIppool" : ["10.1.1.1"],
"isTelcoGateway" : false,
"vrfName" : "extgw_vrf",
"isAllShared" : true,
"fabricConfigs" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fabricRole" : "master",
"fabricName" : "fabricName"
}
],
"serviceIpDefaultPolicy" : true,
"preConfigured" : true,
"interfaceType" : 1,
"routeExportModel" : 1,
"vpnTarget" : "2:2000",
"l3Vni" : 1,
"fabricVpnTarget" : "2:2000",
"deviceGroups" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fabricName" : "fabricName",
"deviceGroupId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceGroupName" : "deviceGroupName",
"deviceName" : "deviceName"
}
],
"type" : "l3-share-export",
"additional" : {
"producer" : "10",

iMaster NCE-Fabric
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.2.2 Update an External Gateway
Typical Scenarios
An external gateway needs to be updated.
Functions
Update an external gateway based on conditions.
Constraints
HTTP Method
PUT
URI

id Yes string 0 to - ID used for the "DBB702C3-77

256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

wrapp Yes REFER For details, see Parameters for -

er ENCE Table 1-343. updating an
external
gateway list.
Table 1-343 ExternalGatewayRestfulDtoWrapper parameters

extern Yes ARRAY For details, see External -

alGate _REFER Table 1-344. gateway


charac This field A5AD-3A9C9E2
ters. cannot be 65309"
updated.
name No string 1 to - External "10"

255 gateway name.
charac This field
ters. cannot be
updated.
descrip No string 0 to - External "10"

tion 255 gateway
charac description.
ters. This field
cannot be
updated.

iMaster NCE-Fabric

gatew No string 1 to - External "Public"

ayType 255 gateway type,
charac which can be
ters. Public or
Private. This
field cannot be
updated.
publicI No array< - - Public IP ["10.1.1.0/24"]

ppool string> address pool of
an external
gateway.
service No array< - - List of IP ["10.1.1.1"]

Ippool string> addresses
connected to
an external
gateway.
isTelco No boolea - - Telco cloud false

Gatew n gateway. This
ay field cannot be
updated.
vrfNa No string 1 to - VRF. This field "extgw_vrf"

me 255 cannot be
charac updated.
ters.
isAllSh No boolea - - Whether the true

ared n field is shared
by all tenants.
This field
cannot be
updated.
fabricC No ARRAY For details, see Fabric, which -

onfigs _REFER Table 1-345. cannot be
ENCE updated.
service No boolea - - Whether the true

IpDefa n public service
ultPoli IP address is
cy enabled. This
parameter
cannot be
updated.

iMaster NCE-Fabric

preConf No boolea - - Whether it is true

igured n pre-configured.
This parameter
cannot be
updated.
interfa No int32 - - Configured 1

ceType egress
interface type,
which cannot
be updated.
routeE No int32 - - Route export 1

xportM mode, which
odel cannot be
updated.
vpnTar No string 1 to - Route target, "2:2000"

get 255 which cannot
charac be updated.
ters.
l3Vni No int32 - - L3VNI, which 1

cannot be
updated.
default No int64 [1-429 - External -

Tag 49672 gateway tag
95] information.
default No int32 [1-255 60 Preference -

Prefere ] attribute of the
nce external
gateway.
fabricV No string 1 to - Fabric import "2:2000"

pnTarg 255 router, which
et charac cannot be
ters. updated.

iMaster NCE-Fabric

device No ARRAY For details, see Device group. -

Groups _REFER Table 1-346. Devices in the
ENCE list must
belong to the
same device
group. If the
logical router
type is Normal,
the value of
this parameter
must be null.
type No string 1 to - External "l3-share-

255 gateway type, export"
charac which cannot
ters. be updated.
additio No REFER For details, see Additional -

nal ENCE Table 1-347. information
class.
Table 1-345 ExternalGatewayFabricDto parameters

id No string 1 to - ID, which "DBB702C3-77

255 cannot be 19-4FE6-
charac updated. A5AD-3A9C9E2
ters. 65309"
fabricI No string 1 to - Fabric ID. This "DBB702C3-77

d 255 field cannot be 19-4FE6-
ters. 65309"
fabricR No string - - Fabric role. The "master"

ole value can be
master or
backup. This
parameter
cannot be
updated.
fabric No string 0 to - Fabric name. "fabricName"

Name 255 This field
charac cannot be
ters. updated.

iMaster NCE-Fabric
Table 1-346 ExternalGatewayDeviceGroupDto parameters

id No string 1 to - ID, which "DBB702C3-77

255 cannot be 19-4FE6-
ters. 65309"

ters. 65309"

Name 255 This field
charac cannot be
ters. updated.
device No string 1 to - Device group "DBB702C3-77

GroupI 255 ID, which 19-4FE6-
d charac cannot be A5AD-3A9C9E2
device No string 0 to - Device group "deviceGroupN

Group 255 name, which ame"
Name charac cannot be
ters. updated.
deviceI No string 0 to - Device ID, "DBB702C3-77

d 256 which cannot 19-4FE6-
charac be updated. A5AD-3A9C9E2
ters. 65309"
device No string 0 to - Device name, "deviceName"

Name 255 which cannot
charac be updated.
ters.

iMaster NCE-Fabric

produc No string 0 to 36 - Producer. This "10"

er charac parameter is
ters. optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
create No string 0 to - Creation time. "2016-03-08T2

At 255 0:19:41.000+00:
charac 00"
ters.
update No string 0 to - Update time. "2016-03-08T2

At 255 0:19:41.000+00:
charac 00"
ters.
Sample Request
HTTP
PUT /controller/dc/v3/publicservice/external-gateways/external-gateway/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"publicIppool" : ["10.1.1.0/24"],
"fabricConfigs" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
}
],
"vpnTarget" : "2:2000",
"l3Vni" : 1,
"deviceGroups" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"additional" : {
"producer" : "10",
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}
}
]
}
Response Parameters
ExternalGatewayRestfulDtoWrapper parameters, For details, see Table 1-336.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"publicIppool" : ["10.1.1.0/24"],
"fabricConfigs" : [

iMaster NCE-Fabric
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"vpnTarget" : "2:2000",
"l3Vni" : 1,
"deviceGroups" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"additional" : {
"producer" : "10",
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.2.3 Delete an External Gateway and Related Interconnection Interfaces
Typical Scenarios
An external gateway and related interconnection interfaces need to be deleted.
Functions
Delete an external gateway and related interconnection interfaces.
Constraints
HTTP Method
DELETE

iMaster NCE-Fabric
URI


charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/publicservice/external-gateways/external-gateway/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.4.2.4 Query an External Gateway
Typical Scenarios
External gateways need to be queried.
Functions
Query external gateways.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/publicservice/external-gateways/access-external-gateway


dex 255
charac
ters.

ze 255
charac
ters.

iMaster NCE-Fabric
Request Parameters

wrapp Yes REFER For details, see Filter criteria -

er ENCE Table 1-351. for querying
external
gateways.
Table 1-351 AccessExternalGatewayDto parameters

id No string 0 to - External "DBB702C3-77

updated.
name No string - - External -

gateway name.
This field
cannot be
updated.
fabricI No string 1 to - External "DBB702C3-77

ds 6044 gateway name. 19-4FE6-
updated.
gatew No string - - External -

ayType gateway type.
The value can
be Route(0),
L2SharePort(1)
,
L3SharePort(2)
,
L3Monopolize(
3),
L3ShareExport(
4), or
DynamicRoute
Export(5).

iMaster NCE-Fabric

protect No ● Sing - Protection -

Type le type.
● Mas
terS
lave
Sample Request
HTTP
POST /controller/dc/v3/publicservice/external-gateways/access-external-gateway?pageIndex=1&pageSize=1
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fabricIds" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
Response Parameters
Table 1-352 ExternalGatewayPagedDtoWrapper parameters

eter t Value
extern ARRAY For details, see Table External -

alGate _REFER 1-337. gateway
totalN int64 1 to - Number of 1

um 2147483647 returned data
characters. records.
pageIn int32 1 to - Page index. 1

dex 2147483647
characters.
pageSi int32 1 to - Page size. 1

ze 2147483647
characters.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"publicIppool" : ["10.1.1.0/24"],
"fabricConfigs" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"vpnTarget" : "2:2000",
"l3Vni" : 1,
"deviceGroups" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"additional" : {
"producer" : "10",
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}
}
],
"totalNum" : 1,
"pageIndex" : 1,
"pageSize" : 1
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.2.5 Query External Gateways
Typical Scenarios
External gateways need to be queried.
Functions
Query external networks based on conditions. Data can be displayed in pages.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/publicservice/external-gateways


dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /controller/dc/v3/publicservice/external-gateways?pageIndex=1&pageSize=1 HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
ExternalGatewayPagedDtoWrapper parameters, For details, see Table 1-352.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"publicIppool" : ["10.1.1.0/24"],
"fabricConfigs" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"vpnTarget" : "2:2000",
"l3Vni" : 1,
"deviceGroups" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}

iMaster NCE-Fabric
],
"additional" : {
"producer" : "10",
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}
}
],
"totalNum" : 1,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.2.6 Update the public IP usage status of an external gateway.
Typical Scenarios
The public IP usage status of an external gateway needs to be updated.
Functions
Update the public IP usage status of an external gateway.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/publicservice/external-gateways/external-gateway/{id}/public-ip


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table Logical -

NCE 1-356. port
configurat
ion.
Table 1-356 ExternalGatewayPublicIpDto parameters

extern Yes string 0 to - External "CEB702C3-771

alGate 256 gateway ID. 9-4FE6-
wayId charac This field A5AD-3A9C9E2
updated.
publicI Yes string 1 to - Public IP "10.23.15.0/24"

p 255 address.
charac
ters.
isUsed Yes boolea - - Flag bit false

n (occupied/
released).
produc Yes string 0 to - Operator. "10"

er 255
charac
ters.
Sample Request
HTTP
PUT /controller/dc/v3/publicservice/external-gateways/external-gateway/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309/public-ip HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"externalGatewayId" : "CEB702C3-7719-4FE6-A5AD-3A9C9E265309",
"publicIp" : "10.23.15.0/24",
"isUsed" : false,

iMaster NCE-Fabric
"producer" : "10"
}
Response Parameters
Table 1-357 ExternalGatewayPublicIpDto parameters

eter t Value
extern string 0 to 256 - External "CEB702C3-771

alGate characters. gateway ID. 9-4FE6-
wayId This field A5AD-3A9C9E2
cannot be 65309"
updated.
publicI string 1 to 255 - Public IP "10.23.15.0/24"

isUsed boolea - - Flag bit false

n (occupied/
released).
produc string 0 to 255 - Operator. "10"

er characters.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"externalGatewayId" : "CEB702C3-7719-4FE6-A5AD-3A9C9E265309",
"publicIp" : "10.23.15.0/24",
"isUsed" : false,
"producer" : "10"
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.4.2.7 Query an External Gateway and Related Interconnection Interfaces
Typical Scenarios
An external gateway and related interconnection interfaces need to be queried.
Functions
Query an external gateway and related interconnection interfaces.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/publicservice/external-gateways/easy-external-gateways


dex 255
charac
ters.

ze 255
charac
ters.
name No string 0 to - Name of an "10"

255 external
charac gateway.
ters.

charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric

type No string - - External "4"

gateway type.
The options are
as follows: 3:
Layer 3
exclusive
egress 4: Layer
3 shared egress
5: Dynamic
route egress
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/publicservice/external-gateways/easy-external-gateways?
pageIndex=1&pageSize=1&name=10&id=DBB702C3-7719-4FE6-A5AD-3A9C9E265309&type=4 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-359 EasyExtGwConnectIfPagedDtoWrapper parameters

eter t Value
extern ARRAY For details, see Table Information -

alGate _REFER 1-360. about the
way ENCE external
gateway and
interconnection
interface.


iMaster NCE-Fabric

eter t Value

dex 2147483647
characters.

ze 2147483647
characters.
Table 1-360 QueryEasyExtGwConnectIfDto parameters

eter t Value

A5AD-3A9C9E2
65309"
name string 1 to 255 - External "10"

characters. gateway name.
descrip string 0 to 255 - Description of "10"

tion characters. the external
gateway.
gatew int32 - - External 4

ayType gateway type.
The options are
as follows: 3:
Layer 3
exclusive
egress 4: Layer
3 shared egress
5: Dynamic
route egress
publicI array< - - Public IP ["192.168.1.0/2

pPool string> address. 4"]
service array< - - Public service ["192.168.1.0/2

IpPool string> IP address. 4"]
isTelco boolea - - Telco cloud false

Gatew n gateway.
ay
vrfNa string 1 to 255 - VRF. "extgw_vrf"

me characters.

iMaster NCE-Fabric

eter t Value
enable boolea - - Whether to true

Escape n enable the
bypass link.
escape string - - IP type of the "Unknown"

IpVersi bypass link.
on The value can
be Ipv4, Ipv6,
or Unknown. If
this parameter
is not set, the
value Unknown
is used.
isAllSh boolea - - Whether the false

ared n external
gateway is
shared by all
tenants.
fabricC ARRAY For details, see Table fabric. -

onfigs _REFER 1-338.
ENCE
service boolea - - Whether to false

IpDefa n bypass the
ultPoli public service
cy IP address of
the cloud
network.
preConf boolea - - Whether to false

igured n perform
preconfiguratio
n.

iMaster NCE-Fabric

eter t Value
interfa int32 - - Whether an 1

ceType outbound
interface is
configured. The
value 0
indicates that
no outbound
interface is
configured. The
value 1
indicates that
an outbound
interface is
configured.
routeE int32 - - Route export 1

xportM mode.
odel
vpnTar string 1 to 255 - Route target. "2:2000"

get characters.
l3Vni int32 - - Layer 3 VNI. 1
default int64 [1-4294967295 - Tag of the -

Tag ] external
gateway.
default int32 - - Default -

Prefere preference.
nce

Groups _REFER 1-361. The devices in
ENCE the list must
belong to the
same device
group.
type string 1 to 255 - External "l3-share-

characters. gateway type. export"
This field
cannot be
updated.

nal ENCE 1-340. information.

iMaster NCE-Fabric

eter t Value
connec ARRAY For details, see Table Interconnection -

tInterf _REFER 1-362. interface.
aces ENCE
Table 1-361 QueryEasyDeviceGroupDto parameters

eter t Value
id string 1 to 255 - Identifier. "DBB702C3-77

A5AD-3A9C9E2
65309"

A5AD-3A9C9E2
65309"

Name characters.

GroupI characters. ID. 19-4FE6-
d A5AD-3A9C9E2
65309"

Group characters. name. ame"
Name
deviceI string 1 to 255 - Device ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
device string 0 to 255 - Device name. "deviceName"

Name characters.
Table 1-362 EasyConnectInterfaceDto parameters

eter t Value

A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
name string 1 to 255 - Name of an "10"

characters. interconnection
interface.
descrip string 0 to 255 - Description of "10"

tion characters. the
interconnection
interface.
vlanId int32 [0-4094] - ID of the VLAN 10

allowed by the
subnet. If the
value is 0, the
encapsulation
type is untag. If
the value is in
the range from
2 to 4094, the
encapsulation
type is Dot1q.
routeIn boolea - - Whether the false

terface n routed
interface is
used.
subInt int32 [1-4094] - Sub-interface 2000

erface number.
Numb
er
connec ARRAY For details, see Table Interface IP -

tionIps _REFER 1-363. address.
ENCE
connec ARRAY For details, see Table Port list. -

tDevic _REFER 1-364.
es ENCE
Table 1-363 EasyConnectionIpDto parameters

eter t Value
localIp string 1 to 255 - Local IP "192.168.10.1/2

characters. address. 4"

iMaster NCE-Fabric

eter t Value
peerIp string 1 to 255 - Peer IP "192.168.10.2/2

characters. address. 4"
Table 1-364 EasyConnectionDeviceDto parameters

eter t Value

A5AD-3A9C9E2
65309"
fabric string 1 to 128 - Fabric name. "theFabric"

Name characters.

d A5AD-3A9C9E2
65309"
device string 1 to 128 - Device group "theFabric"

Group characters. name,
Name

A5AD-3A9C9E2
65309"
device string 1 to 255 - Device name. "CE_45"

Name characters.

me characters.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"gatewayType" : 4,
"publicIpPool" : ["192.168.1.0/24"],
"serviceIpPool" : ["192.168.1.0/24"],
"enableEscape" : true,
"escapeIpVersion" : "Unknown",
"isAllShared" : false,
"fabricConfigs" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"serviceIpDefaultPolicy" : false,
"preConfigured" : false,
"vpnTarget" : "2:2000",
"l3Vni" : 1,
"deviceGroups" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"additional" : {
"producer" : "10",
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
},
"connectInterfaces" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"vlanId" : 10,
"routeInterface" : false,
"subInterfaceNumber" : 2000,
"connectionIps" : [
{
"localIp" : "192.168.10.1/24",
"peerIp" : "192.168.10.2/24"
}
],
"connectDevices" : [
{
"fabricName" : "theFabric",
"deviceGroupName" : "theFabric",
"deviceName" : "CE_45",
"portName" : "10GE1/0/1"

iMaster NCE-Fabric
}
]
}
]
}
],
"totalNum" : 1,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.2.8 Create an External Gateway and Related Interconnection Interfaces

(Invoked in Easy Network Deployment Mode)
Typical Scenarios
The API needs to be invoked in easy network deployment mode, which can be
used to create an external gateway and related interconnection interfaces.
Functions
Create an external gateway and related interconnection interfaces.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/publicservice/external-gateways/easy-external-gateway

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table Parameter -

NCE 1-366. s of the
external
gateway
and
interconn
ected
interfaces.
Table 1-366 EasyExtGwConnectIfDtoWrapper parameters

extern No REFER For details, see Parameters of -

alGate ENCE Table 1-367. the external
way gateway and
interconnected
interfaces.
Table 1-367 EasyExtGwConnectIfDto parameters


charac A5AD-3A9C9E2
ters. 65309"
name Yes string 1 to - Name of an "10"

255 external
charac gateway.
ters.
descrip No string 0 to - Description of "10"

tion 255 the external
charac gateway.
ters.

iMaster NCE-Fabric

type No int32 - - External 4

gateway type.
Only types of
Layer 3 shared
egress and
dynamic route
egress are
supported.
vrfNa No string 1 to - VRF name. "extgw_vrf"

me 255
charac
ters.
service No array< - - Public service ["192.168.1.0/2

IpPool string> IP address. 4"]
publicI No array< - - Public IP ["192.168.1.0/2

pPool string> address. 4"]
routeT No int64 [1-429 - External -

ag 49672 gateway tag
95] information.
routeP No int32 [1-255 60 Preference -

referen ] attribute of the
ce external
gateway.
staticR No boolea - - Egress route true

outeAu n generated
to based on the
public service
IP address.
fabrics No ARRAY For details, see Fabric. -

_REFER Table 1-345.
ENCE
isTelco No boolea - - Telco cloud false

Gatew n gateway.
ay

iMaster NCE-Fabric

interfa No int32 - - Outbound 1

ceType interface mode.
0: No
outbound
interface is
configured. 1:
An outbound
interface is
configured.
enable No boolea - - Whether the true

Escape n best-effort
path is
enabled.
escape No string - - IP address type "Unknown"

IpVersi of the best-
on effort path.
The value can
be Ipv4, Ipv6,
or Unknown. If
this parameter
is left empty,
Unknown is
used. This field
can be
updated.

Groups _REFER Table 1-368. Devices in the
ENCE list must
belong to the
same device
group. If the
logical router
type is Normal,
the value of
this parameter
must be null.
vpnTar No string 1 to - Route target. "2:2000"

get 255
charac
ters.
l3Vni No int32 - - Layer 3 VNI. 1

iMaster NCE-Fabric

vniAllo No string 1 to 32 - VNI allocation "Automatic"

cType charac mode.
ters. Automatic:
automatic
allocation;
Manual:
manual
allocation.
fabricI No string 1 to - Fabric import "2:2000"

mport 255 RT.
Rt charac
ters.
publicI No int32 - - Return route. 0: -

pRoute Host route; 1:
Mode Network
segment route.
connec No ARRAY For details, see Interconnection -

tInterf _REFER Table 1-369. interface.
aces ENCE
Table 1-368 EasyDeviceGroupDto parameters

id No string 1 to - ID. "DBB702C3-77

255 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
fabricI No string 1 to - Fabric ID. "DBB702C3-77

d 255 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

Name 255
charac
ters.

GroupI 255 ID. 19-4FE6-
d charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric


Group 255 name. ame"
Name charac
ters.
Table 1-369 EasyConnectInterfaceDto parameters


charac A5AD-3A9C9E2
ters. 65309"
name Yes string 1 to - Name of an "10"

255 interconnection
charac interface.
ters.
descrip No string 0 to - Description of "10"

tion 255 the
charac interconnection
ters. interface.
vlanId No int32 [0-409 - ID of the VLAN 10

4] allowed by the
subnet. If the
value is 0, the
encapsulation
type is untag. If
the value is in
the range from
2 to 4094, the
encapsulation
type is Dot1q.
routeIn No boolea - - Whether the false

terface n routed
interface is
used.
subInt No int32 [1-409 - Sub-interface 2000

erface 4] number.
Numb
er

iMaster NCE-Fabric

connec Yes ARRAY For details, see Interface IP -

tionIps _REFER Table 1-370. address.
ENCE
connec Yes ARRAY For details, see Port list. -

tDevic _REFER Table 1-371.
es ENCE
Table 1-370 EasyConnectionIpDto parameters

localIp Yes string 1 to - Local IP "192.168.10.1/2

255 address. 4"
charac
ters.
peerIp Yes string 1 to - Peer IP "192.168.10.2/2

255 address. 4"
charac
ters.
Table 1-371 EasyConnectionDeviceDto parameters


d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
fabric No string 1 to - Fabric name. "theFabric"

Name 128
charac
ters.

ters. 65309"
device No string 1 to - Device group "theFabric"

Group 128 name,
Name charac
ters.

iMaster NCE-Fabric

deviceI No string 0 to - Device ID. "DBB702C3-77

d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
device No string 1 to - Device name. "CE_45"

Name 255
charac
ters.
portNa Yes string 0 to - Port name. "10GE1/0/1"

me 255
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/publicservice/external-gateways/easy-external-gateway HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"externalGateway" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"type" : 4,
"serviceIpPool" : ["192.168.1.0/24"],
"publicIpPool" : ["192.168.1.0/24"],
"staticRouteAuto" : true,
"fabrics" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"enableEscape" : true,
"deviceGroups" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceGroupName" : "deviceGroupName"
}
],
"vpnTarget" : "2:2000",
"l3Vni" : 1,

iMaster NCE-Fabric
"vniAllocType" : "Automatic",
"fabricImportRt" : "2:2000",
"connectInterfaces" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"vlanId" : 10,
"subInterfaceNumber" : 2000,
"connectionIps" : [
{
"localIp" : "192.168.10.1/24",
"peerIp" : "192.168.10.2/24"
}
],
"connectDevices" : [
{
"deviceGroupName" : "theFabric",
}
]
}
]
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.3 Routing Policy

# Route policy operation APIs

iMaster NCE-Fabric
1.9.4.3.1 Create a Routing Policy
Typical Scenarios
A routing policy needs to be created.
Functions
Create a routing policy.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/routePolicy/{router_id}/add_route_policy

router_ Yes uuid - - Router ID. "ff000000-

id ff00-0000-
abce-00000000
0001"
Request Parameters

routeP Yes REFER For details, see Parameters for -

olicyDt ENCE Table 1-374. creating a
oWrap routing policy.
per

iMaster NCE-Fabric
Table 1-374 RoutePolicyDtoWrapper parameters

routeP Yes ARRAY 0-255 items. For Routing policy. -

olicys _REFER details, see
ENCE Table 1-375.
Table 1-375 RoutePolicyDto parameters

peer_r Yes string 0 to 36 - Peer router ID. "b1bcd3d8-2f0

outer_i charac 2-4d05-8283-
d ters. ff87ae962224"
peer_fi Yes array< 0-255 - Peer filter "["192.168.199.

lter_cid string> items. CIDR. 0/24"]"
rs Each
item
has 0
to 255
charac
ters.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/routePolicy/ff000000-ff00-0000-abce-000000000001/add_route_policy
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routePolicys" : [
{
"peer_router_id" : "b1bcd3d8-2f02-4d05-8283-ff87ae962224",
"peer_filter_cidrs" : "["192.168.199.0/24"]"
}
]
}
Response Parameters

iMaster NCE-Fabric
Table 1-376 RoutePolicyDtoWrapper parameters

eter t Value
routeP ARRAY 0-255 items. For details, Routing policy. -

olicys _REFER see Table 1-377.
ENCE
Table 1-377 RoutePolicyDto parameters

eter t Value
peer_r string 0 to 36 - Peer router ID. "b1bcd3d8-2f0

outer_i characters. 2-4d05-8283-
d ff87ae962224"
peer_fi array< 0-255 items. - Peer filter "["192.168.199.

lter_cid string> Each item has 0 CIDR. 0/24"]"
rs to 255
characters.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routePolicys" : [
{
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.3.2 Delete a Routing Policy by Router ID
Typical Scenarios
Query a VPC Connection by ID.
Functions
Delete a routing policy by router ID.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v2/neutronapi/routePolicy/{router_id}/delete_route_policy


id ff00-0000-
abce-00000000
0001"

iMaster NCE-Fabric
Request Parameters

routeP Yes REFER For details, see Parameters for -

olicyDt ENCE Table 1-374. deleting a
oWrap routing policy.
per
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/routePolicy/ff000000-ff00-0000-abce-000000000001/
delete_route_policy HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routePolicys" : [
{
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.3.3 Query a Routing Policy by Router ID
Typical Scenarios
A routing policy needs to be queried by router ID.
Functions
Query a routing policy by router ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/routePolicy/{router_id}/query_route_policy


id ff00-0000-
abce-00000000
0001"
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/routePolicy/ff000000-ff00-0000-abce-000000000001/query_route_policy
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-381 RoutePolicyQueryOutputDto parameters

eter t Value
routeP ARRAY 0-255 items. For details, Routing policy. -

olicys _REFER see Table 1-377.
ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routePolicys" : [
{
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.3.4 Update a Routing Policy by Router ID
Typical Scenarios
A routing policy needs to be updated by router ID.
Functions
Update a routing policy by router ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/routePolicy/{router_id}/update_route_policy


id ff00-0000-
abce-00000000
0001"

iMaster NCE-Fabric
Request Parameters

routeP Yes REFER For details, see Routing policy -

olicyDt ENCE Table 1-374. entity to be
oWrap updated.
per
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/routePolicy/ff000000-ff00-0000-abce-000000000001/update_route_policy
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routePolicys" : [
{
}
]
}
Response Parameters
RoutePolicyDtoWrapper parameters, For details, see Table 1-376.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{

iMaster NCE-Fabric
"routePolicys" : [
{
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.3.5 NFVI Routing Policy
Query NFVI Routing Policies
Typical Scenarios
Routing policies need to be queried.
Functions
Query a routing policy.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/nfvi/routepolicy
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/fabricresource/nfvi/routepolicy HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-384 NfviRoutePolicyRestfulDto parameters

eter t Value
loadBa int32 - 32 Number of 32

lanceN load balancing
um entries.
loadBa int64 - - Load balancing 82345

lanceT flag.
ag
bfdInte int32 - - BFD detection 300

rval interval.
bfdMul int32 - - BFD detection 6

tiplier multiplier.
nqaInt int32 - - NQA detection 200

erval interval.
directR int64 - - Direct route 82348

outeTa flag.
g
evpnSu int64 - - EVPN 82346

ppressi suppression
onTag flag.
ebgpR int64 - - EBGP peer 82456

outeTa route label.
g
bestEff string 0 to 200 - Bypass path "besteffortpath

ortPat characters. routing policy. rtp"
hRtp
dciExp string 0 to 200 - DCI export "dciexportrtp"

ortRtp characters. routing policy

iMaster NCE-Fabric

eter t Value
dciImp string 0 to 200 - DCI import "dciimportrtp"

ortRtp characters. routing policy
dciDye string 0 to 200 - DCI colored "dcidyeingrtp"

ingRtp characters. routing policy
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"loadBalanceNum" : 32,
"loadBalanceTag" : 82345,
"bfdInterval" : 300,
"bfdMultiplier" : 6,
"nqaInterval" : 200,
"directRouteTag" : 82348,
"evpnSuppressionTag" : 82346,
"ebgpRouteTag" : 82456,
"bestEffortPathRtp" : "besteffortpathrtp",
"dciExportRtp" : "dciexportrtp",
"dciImportRtp" : "dciimportrtp",
"dciDyeingRtp" : "dcidyeingrtp"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Update NFVI Routing Policies
Typical Scenarios
A routing policy needs to be updated.
Functions
Update a routing policy.

iMaster NCE-Fabric
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/physicalnetwork/fabricresource/nfvi/routepolicy
Request Parameters

er Range Value on

NCE 1-386. paramete
r.
Table 1-386 NfviRoutePolicyRestfulDto parameters

loadBa Yes int32 - 32 Number of 32

lanceN load balancing
um entries.
loadBa Yes int64 - - Load balancing 82345

lanceT flag.
ag
bfdInte Yes int32 - - BFD detection 300

rval interval.
bfdMul Yes int32 - - BFD detection 6

tiplier multiplier.
nqaInt Yes int32 - - NQA detection 200

erval interval.
directR Yes int64 - - Direct route 82348

outeTa flag.
g

iMaster NCE-Fabric

evpnSu Yes int64 - - EVPN 82346

ppressi suppression
onTag flag.
ebgpR Yes int64 - - EBGP peer 82456

outeTa route label.
g
bestEff No string 0 to - Bypass path "besteffortpath

ortPat 200 routing policy. rtp"
hRtp charac
ters.
dciExp No string 0 to - DCI export "dciexportrtp"

ortRtp 200 routing policy
charac
ters.
dciImp No string 0 to - DCI import "dciimportrtp"

ortRtp 200 routing policy
charac
ters.
dciDye No string 0 to - DCI colored "dcidyeingrtp"

ingRtp 200 routing policy
charac
ters.
Sample Request
HTTP
PUT /controller/dc/v3/physicalnetwork/fabricresource/nfvi/routepolicy HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
}

iMaster NCE-Fabric
Response Parameters
NfviRoutePolicyRestfulDto parameters, For details, see Table 1-384.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.4 BFD System Configuration Management

BFD API description:
1. Add, delete, modify, and query the BFD system configuration.
2. Add and delete the device group applied in the BFD system.
1.9.4.4.1 Create BFD System Configuration
Typical Scenarios
BFD system configuration needs to be created.

iMaster NCE-Fabric
Functions
Create BFD system configuration to enable the BFD feature for specified devices in
the fabric.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/fabricresource/bfds
Request Parameters

er Range Value on

NCE 1-388. paramete
r model
class for
creating
BFD
system
configurat
ion.
Table 1-388 BfdSystemDtoWrapper parameters

bfd Yes ARRAY For details, see "" -

_REFER Table 1-389.
ENCE

iMaster NCE-Fabric
Table 1-389 BfdSystemDto parameters

id No string 0 to - Object ID. "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
name No string 1 to - BFD session "bfd1"

255 name, which
charac contains only
ters. digits,
uppercase and
lowercase
letters, and
underscores
(_). This
parameter can
be updated.
descrip No string 0 to - Description. "This is for

tion 255 The value can tenant1."
charac be changed.
ters.
device No REFER For details, see "" -

Group ENCE Table 1-390.
delayU No int32 [0-600 0 Delay for a 200

pTimer ] BFD session to
go Up. The
default value is
0, indicating
that the BFD
session is
disabled. This
parameter can
be updated.
initWai No int32 [1-360 2000 First BFD 2000

tTime 0000] session
suppression
time, in
milliseconds.
The default
value is 2000
ms. This
parameter can
be updated.

iMaster NCE-Fabric

maxW No int32 [1-360 12000 Maximum BFD 12000

aitTim 0000] session
e suppression
time, in
milliseconds.
The default
value is 12,000
ms. This
parameter can
be updated.
second No int32 [1-360 5000 Second BFD 5000

WaitTi 0000] session
me suppression
time, in
milliseconds.
The default
value is 5000
ms. This
parameter can
be updated.
linkBu No int32 [6000- 16000 First BFD link- 16000

ndleIni 36000 bundle session
tTime 00] suppression
time, in
milliseconds.
The default
value is 16,000
ms. This
parameter can
be updated.
linkBu No int32 [20000 600000 Maximum BFD 600000

ndleM -36000 link-bundle
axTime 00] session
suppression
time, in
milliseconds.
The default
value is
600,000 ms.
This parameter
can be
updated.

iMaster NCE-Fabric

linkBu No int32 [10000 20000 Second BFD 20000

ndleSe -36000 link-bundle
condTi 00] session
me suppression
time, in
milliseconds.
The default
value is 20,000
ms. This
parameter can
be updated.
linkBu No boolea - false Whether only false

ndleL3 n the main BFD
Mode link-bundle
session
flapping is
suppressed.
This parameter
can be
updated.
deliver No int32 - 2 Delivery status. 2

State 1: Ongoing. 2:
Delivered. This
parameter is
read-only.
Table 1-390 BfdSystemDevGrpDtoWrapper parameters


d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
fabric No string 0 to - Fabric name, "fabric1"

Name 255 which is read-
charac only.
ters.
device Yes ARRAY For details, see "" -

Group _REFER Table 1-391.
ENCE

iMaster NCE-Fabric
Table 1-391 BfdSystemDevGrpDto parameters

device Yes string 0 to - Device group "DBB702C3-77

ters. 65309"
device No string 0 to - Name of the "CE6881"

Group 255 device group
Name charac where BFD is
ters. deployed. This
parameter is
read-only.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/fabricresource/bfds HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"bfd" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"description" : "This is for tenant1.",
"deviceGroup" : {
"fabricName" : "fabric1",
"deviceGroup" : [
{
"deviceGroupName" : "CE6881"
}
]
},
"delayUpTimer" : 200,
"initWaitTime" : 2000,
"maxWaitTime" : 12000,
"secondWaitTime" : 5000,
"linkBundleInitTime" : 16000,
"linkBundleMaxTime" : 600000,
"linkBundleSecondTime" : 20000,
"linkBundleL3Mode" : false,
"deliverState" : 2
}
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.4.2 Query the BFD System Configuration List
Typical Scenarios
The BFD system configuration list needs to be queried.
Functions
Query the BFD system configuration list by condition.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/bfds

iMaster NCE-Fabric


dex 74836
47]
pageSi No string [1-400 - Page size. "1"

ze 0]
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/physicalnetwork/fabricresource/bfds?pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-393 BfdSystemPagedDtoWrapper parameters

eter t Value
bfd ARRAY For details, see Table "" -

_REFER 1-394.
ENCE
totalN int64 [1-1000] - Total number 10

um of BFD
configuration
items queried,
which is read-
only.

dex ]

ze

iMaster NCE-Fabric
Table 1-394 BfdSystemDto parameters

eter t Value
id string 0 to 256 - Object ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
name string 1 to 255 - BFD session "bfd1"

characters. name, which
contains only
digits,
uppercase and
lowercase
letters, and
underscores
(_). This
parameter can
be updated.
descrip string 0 to 255 - Description. "This is for

tion characters. The value can tenant1."
be changed.
device REFER For details, see Table "" -

Group ENCE 1-395.
delayU int32 [0-600] 0 Delay for a 200

pTimer BFD session to
go Up. The
default value is
0, indicating
that the BFD
session is
disabled. This
parameter can
be updated.
initWai int32 [1-3600000] 2000 First BFD 2000

tTime session
suppression
time, in
milliseconds.
The default
value is 2000
ms. This
parameter can
be updated.

iMaster NCE-Fabric

eter t Value
maxW int32 [1-3600000] 12000 Maximum BFD 12000

aitTim session
e suppression
time, in
milliseconds.
The default
value is 12,000
ms. This
parameter can
be updated.
second int32 [1-3600000] 5000 Second BFD 5000

WaitTi session
me suppression
time, in
milliseconds.
The default
value is 5000
ms. This
parameter can
be updated.
linkBu int32 [6000-3600000 16000 First BFD link- 16000

ndleIni ] bundle session
tTime suppression
time, in
milliseconds.
The default
value is 16,000
ms. This
parameter can
be updated.
linkBu int32 [20000-360000 600000 Maximum BFD 600000

ndleM 0] link-bundle
axTime session
suppression
time, in
milliseconds.
The default
value is
600,000 ms.
This parameter
can be
updated.

iMaster NCE-Fabric

eter t Value
linkBu int32 [10000-360000 20000 Second BFD 20000

ndleSe 0] link-bundle
condTi session
me suppression
time, in
milliseconds.
The default
value is 20,000
ms. This
parameter can
be updated.
linkBu boolea - false Whether only false

ndleL3 n the main BFD
Mode link-bundle
session
flapping is
suppressed.
This parameter
can be
updated.
deliver int32 - 2 Delivery status. 2

State 1: Ongoing. 2:
Delivered. This
parameter is
read-only.
Table 1-395 BfdSystemDevGrpDtoWrapper parameters

eter t Value

A5AD-3A9C9E2
65309"
fabric string 0 to 255 - Fabric name, "fabric1"

Name characters. which is read-
only.
device ARRAY For details, see Table "" -

Group _REFER 1-396.
ENCE

iMaster NCE-Fabric
Table 1-396 BfdSystemDevGrpDto parameters

eter t Value

d A5AD-3A9C9E2
65309"
device string 0 to 255 - Name of the "CE6881"

Group characters. device group
Name where BFD is
deployed. This
parameter is
read-only.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"bfd" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"deviceGroup" : {
"deviceGroup" : [
{
}
]
},
"deliverState" : 2
}
],
"totalNum" : 10,
"pageIndex" : 10,

iMaster NCE-Fabric
"pageSize" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.4.3 Query BFD System Configuration
Typical Scenarios
Specific BFD system configuration needs to be queried.
Functions
Query specific BFD system configuration.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/physicalnetwork/fabricresource/bfds/bfd/{id}


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /controller/dc/v3/physicalnetwork/fabricresource/bfds/bfd/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-398 BfdSystemDtoWrapper parameters

eter t Value
bfd ARRAY For details, see Table "" -

_REFER 1-394.
ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"bfd" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"deviceGroup" : {
"deviceGroup" : [
{
}
]
},

iMaster NCE-Fabric
"deliverState" : 2
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.4.4 Update BFD System Configuration
Typical Scenarios
Specific BFD system configuration needs to be updated.
Functions
Update specific BFD system configuration, including BFD parameters or device list.
If the device list needs to be updated, the PUT operation supports only full update
and replacement.
Constraints
HTTP Method
PUT
URI

id Yes string 0 to - ID of the BFD "DBB702C3-77

256 system 19-4FE6-
charac configuration A5AD-3A9C9E2
ters. item to be 65309"
updated.

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-388. paramete
r model
class for
updating
BFD
system
configurat
ion.
Sample Request
HTTP
PUT /controller/dc/v3/physicalnetwork/fabricresource/bfds/bfd/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"bfd" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"deviceGroup" : {
"deviceGroup" : [
{
}
]
},
"deliverState" : 2
}
]
}

iMaster NCE-Fabric
Response Parameters
BfdSystemDtoWrapper parameters, For details, see Table 1-398.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"bfd" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"deviceGroup" : {
"deviceGroup" : [
{
}
]
},
"deliverState" : 2
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.4.5 Delete BFD System Configuration
Typical Scenarios
Specific BFD system configuration needs to be deleted.

iMaster NCE-Fabric
Functions
Delete specific BFD system configuration and disable the BFD feature for the
Fabric. This is a high-risk operation and can be performed only when all BFD
sessions are deleted.
Constraints
HTTP Method
DELETE
URI

id Yes string 0 to - ID of the BFD "DBB702C3-77

256 system 19-4FE6-
charac configuration A5AD-3A9C9E2
ters. item to be 65309"
deleted.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/physicalnetwork/fabricresource/bfds/bfd/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.4.6 Add a Device to BFD System Configuration
Typical Scenarios
A device needs to be added to specific BFD system configuration.
Functions
Add a device to specific BFD system configuration.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/fabricresource/bfds/bfd/{id}/add-device

id Yes string 0 to - Object ID. "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-390. paramete
r model
class for
adding a
device.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/fabricresource/bfds/bfd/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309/add-device HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceGroup" : [
{
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.4.7 Remove a Device from BFD System Configuration
Typical Scenarios
BFD system configurations need to be created. This operation is risky and affects
all BFD sessions on the device.
This API cannot be used to disable BFD globally on the device to prevent the
manually configured BFD sessions from being deleted by mistake.
Functions
Create BFD system configuration to enable the BFD feature for specified devices in
the fabric.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/physicalnetwork/fabricresource/bfds/bfd/{id}/remove-device

id Yes string 0 to - Object ID. "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-390. paramete
r model
class for
removing
a device.
Sample Request
HTTP
POST /controller/dc/v3/physicalnetwork/fabricresource/bfds/bfd/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309/remove-device HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceGroup" : [
{
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.5 Global Resources

Description of the user object operation API:
1. Create or delete resource pools in batches based on information such as the

type.
2. Query all resources by information such as the type.
1.9.4.5.1 Create a Resource Pool
Typical Scenarios
A resource pool needs to be created.
Functions
Create a resource pool.
Constraints
HTTP Method
POST
URI
/acdcn/v3/topoapi/day0topo/openapi/resourcepool/{type}

type Yes string 1 to 36 - type. "vni"

charac
ters.

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table Day0Reso -

NCE 1-408. urceDto
Table 1-408 CreateResourceDto parameters

gid No string - - - -
begin Yes int64 - - - -
end Yes int64 - - - -
vniTyp No int32 - - - -
e
priority Yes int32 - - - -

Type
Sample Request
HTTP
POST /acdcn/v3/topoapi/day0topo/openapi/resourcepool/vni HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Response status code 200: success

iMaster NCE-Fabric
Table 1-409 Day0ResourceResponse parameters

eter t Value
result string ● SUCCESS - Result type. -

● ERROR
● INPUT_NOT_
EXISTS
● EXCEPTION_
OCCURS
● RPC_RESULT
_IS_WRONG
● PREPARE_SE
RVICE_IS_NU
LL
● REQUEST_PA
RAM_IS_WR
ONG
● URL_PARAM
_TYPE_IS_W
RONG
● BODY_PARA
M_VNITYPE_
IS_WRONG
● BODY_PARA
M_BEGIN_IS
_WRONG
● BODY_PARA
M_END_IS_
WRONG
● BODY_PARA
M_PRIORITY
TYPE_IS_WR
ONG
excepti string - - Error -

onMsg information.
Response status code 500: nternal server error.

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.5.2 Delete a Resource Pool
Typical Scenarios
A resource pool needs to be deleted.
Functions
Destroy a resource pool.
Constraints
HTTP Method
PUT
URI
/acdcn/v3/topoapi/day0topo/openapi/resourcepool/{type}

type Yes string 1 to 36 - type. "vni"

charac
ters.

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table DeleteRes -

NCE 1-412. ourceDto
Table 1-412 DeleteResourceDto parameters

gid No string - - - -
begin Yes int64 - - - -
end Yes int64 - - - -
vniTyp No int32 - - - -
e
priority No int32 - - - -
Type
Sample Request
HTTP
PUT /acdcn/v3/topoapi/day0topo/openapi/resourcepool/vni HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Day0ResourceResponse parameters, For details, see Table 1-409.
Response status code 500: Resource pools need to be created or deleted in

batches.
Sample Response

iMaster NCE-Fabric
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Response status code 500: Resource pools need to be created or deleted in

batches.
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.5.3 Create or destroy resource pools in batches.
Typical Scenarios
Resource pools need to be created or deleted in batches.
Functions
Create or destroy resource pools in batches.
Constraints
HTTP Method
PUT
URI
/acdcn/v3/topoapi/day0topo/openapi/resourcepools/{type}

type Yes string 0 to - type. "vni"

255
charac
ters.

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table Resource -

NCE 1-415. informati
on.
Table 1-415 ResourceDtoWrapper parameters

gid No string - - gid "DBB702C3-77

19-4FE6-
A5AD-3A9C9E2
60001"
vniTyp Yes int32 - - - -

e
operat Yes string - - Operation type. "create"

eType The value can
be create or
delete.
resourc Yes ARRAY For details, see Resource list. -

eList _REFER Table 1-416.
ENCE
Table 1-416 ResourceDto parameters

begin Yes int64 - - End time. 1
end Yes int64 - - End time. 2
priority No int32 - - Result type. 100

Type
Sample Request
HTTP
PUT /acdcn/v3/topoapi/day0topo/openapi/resourcepools/vni HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"gid" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
"operateType" : "create",
"resourceList" : [
{
"begin" : 1,
"end" : 2,
"priorityType" : 100
}
]
}
Response Parameters
Day0ResourceResponse parameters, For details, see Table 1-409.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.6 Easy VPC Management

Easy VPC management API description:
1. Create an easy VPC.
1.9.4.6.1 Create an Easy VPC
Typical Scenarios
An easy VPC needs to be created.
Functions
Create an easy VPC.

iMaster NCE-Fabric
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/easyvpc
Request Parameters

er Range Value on
input REFERE For details, see Table Easy VPC. -

NCE 1-418.
Table 1-418 EasyVpcWrapper parameters

easyVp No REFER For details, see Easy VPC -

c ENCE Table 1-419. information.

iMaster NCE-Fabric
Table 1-419 EasyVpcDto parameters

id No string 0 to 36 - VPC ID. If the "DBB702C3-77

charac VPC already 19-4FE6-
ters. exists, set this A5AD-3A9C9E2
36 parameter to 65301"
charac the ID of the
ters. existing VPC.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 1 to - Name of the "theEasyVpcNa

255 VPC to be me"
charac created.
ters.

iMaster NCE-Fabric

fabricI No string 0 to 36 - Fabric ID. The "DBB702C3-77

d charac fabric ID is 19-4FE6-
ters. preferentially A5AD-3A9C9E2
36 applied, but 65302"
charac either the
ters. fabric ID or
The name must be
value specified.
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
fabric No string 1 to - Fabric name. "theFabric"

Name 128 The fabric ID is
charac preferentially
ters. applied, but
either the
fabric ID or
name must be
specified.

iMaster NCE-Fabric

tenantI No string 0 to 36 - Tenant ID. If "DBB702C3-77

d charac the tenant 19-4FE6-
ters. already exists, A5AD-3A9C9E2
36 set this 65303"
charac parameter to
ters. the ID of the
The existing tenant.
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
tenant No string 1 to - Name of the "theTenant"

Name 128 tenant to be
charac created.
ters.

iMaster NCE-Fabric

extern No string 0 to 36 - ID of the "DBB702C3-77

alGate charac external 19-4FE6-
wayId ters. gateway used A5AD-3A9C9E2
36 to access the 65304"
charac external
ters. network. The
The external
value gateway ID is
must preferentially
meet applied.
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
extern No string 1 to - Name of the "theExternalGa

alGate 255 external teway"
wayNa charac gateway used
me ters. to access the
external
network. The
external
gateway ID is
preferentially
applied.
vlanLis Yes ARRAY 0-200 items. For List of subnet -

t _REFER details, see CIDR and
ENCE Table 1-420. VLAN
information.

iMaster NCE-Fabric

portGr Yes ARRAY 0-200 items. For Port group -

oupList _REFER details, see information.
ENCE Table 1-421.
Table 1-420 VlanDto parameters

vlan Yes int32 [0-409 - ID of the VLAN 10

4] allowed by the
subnet. If the
value is 0, the
encapsulation
type is untag. If
the value is in
the range from
2 to 4094, the
encapsulation
type is Dot1q.
cidr No string 1 to - Gateway IP "192.168.10.1/2

255 address and 4"
charac mask. If this
ters. parameter is
not specified,
only the Layer
2 configuration
is delivered.

iMaster NCE-Fabric
Table 1-421 PortGroupDto parameters

portGr No string 0 to 36 - Port group ID. "DBB702C3-77

oupId charac The port group 19-4FE6-
ters. ID is A5AD-3A9C9E2
36 preferentially 65305"
charac applied, but
ters. either the port
The group ID or
value name must be
must specified.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
portGr No string 1 to - Port group "thePortGroup"

oupNa 255 name. The port
me charac group ID is
ters. preferentially
applied, but
either the port
group ID or
name must be
specified.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/easyvpc HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"easyVpc" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265301",
"name" : "theEasyVpcName",
"tenantId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265303",
"tenantName" : "theTenant",
"externalGatewayId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265304",
"externalGatewayName" : "theExternalGateway",
"vlanList" : [
{
"vlan" : 10,
"cidr" : "192.168.10.1/24"
}
],
"portGroupList" : [
{
"portGroupId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265305",
"portGroupName" : "thePortGroup"
}
]
}
}
Response Parameters
Table 1-422 EasyVpcOutputWrapper parameters

eter t Value
id string 0 to 36 - VPC ID. "DBB702C3-77

characters. 36 19-4FE6-
characters. The A5AD-3A9C9E2
value must 65306"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - VPC name. "theEasyVpcNa

characters. me"

iMaster NCE-Fabric

eter t Value
tenantI string 0 to 36 - Tenant ID. "DBB702C3-77

d characters. 36 19-4FE6-
value must 65307"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
tenant string 1 to 128 - Tenant name. "theTenant"

Name characters.
fabricI string 0 to 36 - Fabric ID. The "DBB702C3-77

d characters. 36 fabric ID is 19-4FE6-
characters. The preferentially A5AD-3A9C9E2
value must applied, but 65308"
meet the either the
following fabric ID or
regular name must be
expression: specified.
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
fabric string 1 to 128 - Fabric name. "theFabric"

Name characters. The fabric ID is
preferentially
applied, but
either the
fabric ID or
name must be
specified.

iMaster NCE-Fabric

eter t Value
extern string 0 to 36 - External "DBB702C3-77

alNetw characters. 36 network ID. 19-4FE6-
orkId characters. The A5AD-3A9C9E2
value must 65309"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
extern string 1 to 255 - External "theExternalNe

alNetw characters. network name. twork"
orkNa
me
logicR string 0 to 36 - Logical router "DBB702C3-77

outerId characters. 36 ID. 19-4FE6-
value must 6530a"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
logicR string 1 to 255 - Logical router "theLogicRoute

outerN characters. name. r"
ame

iMaster NCE-Fabric

eter t Value

alConn characters. 36 connection ID. 19-4FE6-
ectId characters. The A5AD-3A9C9E2
value must 6530b"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
extern string 1 to 255 - External "theExternalCo

alConn characters. connection nnect"
ectNa name.
me
reques string 0 to 36 - Request ID, "DBB702C3-77

tId characters. 36 which can be 19-4FE6-
characters. The used to query A5AD-3A9C9E2
value must southbound 6530e"
meet the operation logs.
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
taskIds array< 0-255 items. - List of task IDs. -

string> Each item has 0
to 36
characters.
logicS ARRAY For details, see Table List of logical -

witch _REFER 1-423. switch
ENCE information.

iMaster NCE-Fabric
Table 1-423 LogicSwitchOutputDto parameters

eter t Value
logicS string 0 to 36 - Port group ID. "DBB702C3-77

witchId characters. 36 19-4FE6-
value must 6530c"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
logicS string 1 to 255 - Logical switch "theLogicSwitc

witchN characters. name. h"
ame
cidr array< 0-255 items. - CIDR list. -

to 255
characters.
portGr ARRAY For details, see Table List of port -

oupList _REFER 1-424. groups bound
ENCE to logical
switches.

iMaster NCE-Fabric
Table 1-424 PortGroupOutputDto parameters

eter t Value
portGr string 0 to 36 - Port group ID. "DBB702C3-77

oupId characters. 36 19-4FE6-
value must 6530d"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
portGr string 1 to 255 - Port group "thePortGroup"

oupNa characters. name.
me
vlan int32 [0-4094] - ID of the VLAN 10

allowed by the
subnet. If the
value is 0, the
encapsulation
type is untag. If
the value is in
the range from
2 to 4094, the
encapsulation
type is Dot1q.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265306",
"name" : "theEasyVpcName",

iMaster NCE-Fabric
"tenantName" : "theTenant",
"externalNetworkId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"externalNetworkName" : "theExternalNetwork",
"logicRouterId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E26530a",
"logicRouterName" : "theLogicRouter",
"externalConnectId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E26530b",
"externalConnectName" : "theExternalConnect",
"requestId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E26530e",
"taskIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E26530f"
],
"logicSwitch" : [
{
"logicSwitchId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E26530c",
"logicSwitchName" : "theLogicSwitch",
"cidr" : [
"192.168.10.1/24"
],
"portGroupList" : [
{
"portGroupId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E26530d",
"portGroupName" : "thePortGroup",
"vlan" : 10
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.7 DiffServ Domain Management

Interfaces in the DiffServ domain are described as follows:
1. Create a DiffServ domain.
2. Update a DiffServ domain.
3. Delete a DiffServ domain.
4. Query the DiffServ domain.
5. Query the DiffServ domain list.
1.9.4.7.1 Create a DiffServ Domain
Typical Scenarios
A DiffServ domain needs to be created.
Functions
Create a DiffServ domain.

iMaster NCE-Fabric
Constraints
HTTP Method
POST
URI
/controller/dc/v3/publicservice/diffservs
Request Parameters

er Range Value on

NCE 1-426. paramete
r
informati
on.
Table 1-426 DiffServDtoWrapper parameters

diffSer Yes ARRAY 1 items. For DiffServ -

v _REFER details, see domain

iMaster NCE-Fabric
Table 1-427 DiffServDto parameters

id No string 0 to 36 - ID. "00278832-

charac cec9-490e-
ters. b222-8bef7f23
36 9523"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name Yes string 1 to 31 - Name. "diffserv001"

charac
ters.
descrip No string 0 to - Description. "diffserv001des

tion 255 "
charac
ters.

iMaster NCE-Fabric

fabricI Yes string 0 to 36 - FabricID. "00278832-

d charac cec9-490e-
ters. b222-8bef7f23
36 9508"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
upStre Yes ARRAY 1-128 items. For Upstream port -

amPor _REFER details, see list.
ts ENCE Table 1-428.
priority Yes ARRAY 1-8 items. For Priority -

Mappi _REFER details, see mapping list.
ngs ENCE Table 1-429.

nal ENCE Table 1-430. information.

iMaster NCE-Fabric
Table 1-428 UpStreamPortDto parameters

device Yes string 0 to 36 - Device group "00278832-

GroupI charac ID cec9-490e-
d ters. b222-8bef7f23
36 9523"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
device No string 0 to - Device group "BorderLeaf"

Group 255 name, which is
Name charac read-only.
ters.

iMaster NCE-Fabric

deviceI Yes string 0 to 36 - Device ID. "00278832-

d charac cec9-490e-
ters. b222-8bef7f23
36 9523"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
device No string 0 to - Device name, "CE6850"

Name 255 which is read-
charac only.
ters.

iMaster NCE-Fabric

portId Yes string 0 to 36 - Port ID. "00278832-

charac cec9-490e-
ters. b222-8bef7f23
36 9523"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
portNa Yes string 0 to - Interface "10GE1/0/32"

me 255 name.
charac
ters.

iMaster NCE-Fabric
Table 1-429 PriorityMappingDto parameters

service Yes string ● be be Data Type "be"

Name Value - be: BE -
● af1
af1: AF1 - af2:
● af2 AF2 - af3: AF3
● af3 - af4: AF4 - ef:
● af4 EF - cs6: CS6 -
cs7: CS7
● ef
● cs6
● cs7
dscp Yes int32 [0-63] - DSCP value. 1

produc No string 0 to 36 - Producer. This "default"

specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
create No string 0 to - Creation time. "2017-08-10

At 255 16:30:40"
charac
ters.
update No string 0 to - Update time. "2017-08-10

At 255 16:30:40"
charac
ters.

iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v3/publicservice/diffservs HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"diffServ" : [
{
"id" : "00278832-cec9-490e-b222-8bef7f239523",
"name" : "diffserv001",
"description" : "diffserv001des",
"fabricId" : "00278832-cec9-490e-b222-8bef7f239508",
"upStreamPorts" : [
{
"deviceGroupId" : "00278832-cec9-490e-b222-8bef7f239523",
"deviceGroupName" : "BorderLeaf",
"deviceId" : "00278832-cec9-490e-b222-8bef7f239523",
"portId" : "00278832-cec9-490e-b222-8bef7f239523",
}
],
"priorityMappings" : [
{
"serviceName" : "be",
"dscp" : 1
}
],
"additional" : {
"producer" : "default",
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.7.2 Query the DiffServ Domain List
Typical Scenarios
The DiffServ domain list needs to be queried.
Functions
Query the DiffServ domain list.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/publicservice/diffservs

produc No string 0 to 36 - producer. "default"

er charac
ters.
name No string 0 to 36 - Name. "diffserv1"

charac
ters.
pageIn No string 0 to - Name. "1"

dex 255
charac
ters.
pageSi No string 0 to - Name. "1"

ze 255
charac
ters.

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/publicservice/diffservs?producer=default&name=diffserv1&pageIndex=1&pageSize=1
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-432 DiffServPagedDtoWrapper parameters

eter t Value
diffSer ARRAY 0-4000 items. For details, DiffServ -

v _REFER see Table 1-433. domain
ENCE information.
totalN int64 [1-2147483647 - Total number. 200

um ]
pageIn int32 [1-2147483647 - Page number. 1

dex ]
pageSi int32 [1-4000] - Number of 1

ze records on
each page.

iMaster NCE-Fabric
Table 1-433 DiffServDto parameters

eter t Value
id string 0 to 36 - ID. "00278832-

characters. 36 cec9-490e-
characters. The b222-8bef7f23
value must 9523"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 31 - Name. "diffserv001"

characters.
descrip string 0 to 255 - Description. "diffserv001des

tion characters. "
fabricI string 0 to 36 - FabricID. "00278832-

d characters. 36 cec9-490e-
value must 9508"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
upStre ARRAY 1-128 items. For details, Upstream port -

amPor _REFER see Table 1-434. list.
ts ENCE
priority ARRAY 1-8 items. For details, see Priority -

Mappi _REFER Table 1-435. mapping list.
ngs ENCE


iMaster NCE-Fabric
Table 1-434 UpStreamPortDto parameters

eter t Value
device string 0 to 36 - Device group "00278832-

GroupI characters. 36 ID cec9-490e-
d characters. The b222-8bef7f23
value must 9523"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
device string 0 to 255 - Device group "BorderLeaf"

Group characters. name, which is
Name read-only.
deviceI string 0 to 36 - Device ID. "00278832-

d characters. 36 cec9-490e-
value must 9523"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
device string 0 to 255 - Device name, "CE6850"

Name characters. which is read-
only.

iMaster NCE-Fabric

eter t Value
portId string 0 to 36 - Port ID. "00278832-

value must 9523"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
portNa string 0 to 255 - Interface "10GE1/0/32"

me characters. name.
Table 1-435 PriorityMappingDto parameters

eter t Value
service string ● be be Data Type "be"

Name Value - be: BE -
● af1
af1: AF1 - af2:
● af2 AF2 - af3: AF3
● af3 - af4: AF4 - ef:
● af4 EF - cs6: CS6 -
cs7: CS7
● ef
● cs6
● cs7
dscp int32 [0-63] - DSCP value. 1

iMaster NCE-Fabric

eter t Value
produc string 0 to 36 - Producer. This "default"

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
create string 0 to 255 - Creation time. "2017-08-10

At characters. 16:30:40"
update string 0 to 255 - Update time. "2017-08-10

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"diffServ" : [
{
"id" : "00278832-cec9-490e-b222-8bef7f239523",
"upStreamPorts" : [
{
}

iMaster NCE-Fabric
],
{
"dscp" : 1
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.7.3 Query a DiffServ Domain
Typical Scenarios
The DiffServ domain needs to be queried.
Functions
Query the DiffServ domain.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/publicservice/diffservs/diffserv/{id}

iMaster NCE-Fabric

id Yes string 0 to 36 - ID used for "DBB702C3-77

charac querying 19-4FE6-
ters. tenant resource A5AD-3A9C9E2
36 statistics. 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/publicservice/diffservs/diffserv/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-438 DiffServDtoWrapper parameters

eter t Value
diffSer ARRAY 1 items. For details, see DiffServ -

v _REFER Table 1-433. domain
ENCE information.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"diffServ" : [
{
"id" : "00278832-cec9-490e-b222-8bef7f239523",
"upStreamPorts" : [
{
}
],
{
"dscp" : 1
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.7.4 Update a DiffServ Domain
Typical Scenarios
A DiffServ domain needs to be updated.
Functions
Update a DiffServ domain.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes string 0 to 36 - Update by ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
36 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

er Range Value on

NCE 1-426. paramete
r
informati
on.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v3/publicservice/diffservs/diffserv/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"diffServ" : [
{
"id" : "00278832-cec9-490e-b222-8bef7f239523",
"upStreamPorts" : [
{
}
],
{
"dscp" : 1
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Response Parameters
DiffServDtoWrapper parameters, For details, see Table 1-438.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"diffServ" : [

iMaster NCE-Fabric
{
"id" : "00278832-cec9-490e-b222-8bef7f239523",
"upStreamPorts" : [
{
}
],
{
"dscp" : 1
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.7.5 Delete a DiffServ Domain
Typical Scenarios
A DiffServ domain needs to be deleted.
Functions
Delete a DiffServ domain.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric

id Yes string 0 to 36 - Deletion by ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
36 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/publicservice/diffservs/diffserv/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.8 Tenant Management

Tenant management API description: 1. Query tenants and resource usage of
them. 2. Create tenants. 3. Update tenants. 4. Delete tenants.
1.9.4.8.1 Create a Tenant
Typical Scenarios
A tenant needs to be created.
Functions
Create a tenant based on the request information.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/tenants

iMaster NCE-Fabric
Request Parameters


er ENCE Table 1-443. creating a
tenant.
Table 1-443 TenantRestfulDtoWrapper parameters

tenant Yes ARRAY For details, see Tenant -

_REFER Table 1-444. information
ENCE

iMaster NCE-Fabric
Table 1-444 TenantDto parameters

id Yes string 36 - Tenant ID. This "DBB702C3-77

charac field cannot be 19-4FE6-
ters. updated. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name Yes string 1 to - Tenant name. "name"

128
charac
ters.
descrip No string 0 to - Tenant "description"

charac
ters.

iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 16:30:40"
charac
ters.

At 255 16:30:40"
charac
ters.
multic No boolea - false Whether the true

astCap n multicast
supported.
quota No REFER For details, see Quota. -

ENCE Table 1-445.
multic No REFER For details, see Multicast -

astQuo ENCE Table 1-446. quota.
ta
resPool No REFER For details, see Resource Pool -

ENCE Table 1-447.
Table 1-445 QuotaDto parameters

logicV Yes int32 [0-214 0 Quota of 10

asNum 74836 logical VAS
47] devices.

iMaster NCE-Fabric

logicR Yes int32 [0-214 0 Quota of 10

outerN 74836 logical routers.
um 47]
logicS Yes int32 [0-214 0 Quota of 10

witchN 74836 logical
um 47] switches.
Table 1-446 MulticastQuotaDto parameters

aclNu Yes int32 [0-100 0 Quota of ACLs. 10

m 0]
aclRule Yes int32 [0-300 0 Quota of ACL 10

Num 0] rules.
Table 1-447 ResPoolDto parameters

extern No array< - - External -

alGate string> Gateway Ids
wayIds
fabricI No array< - - Fabric Ids -

ds string>
vmmId No array< - - Vmm Ids -

s string>
dhcpGr No array< - - DHCP Group -

oupIds string> Ids
Sample Request
HTTP
POST /controller/dc/v3/tenants HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
{
"tenant" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40",
"multicastCapability" : true,
"quota" : {
"logicVasNum" : 10,
"logicRouterNum" : 10,
"logicSwitchNum" : 10
},
"multicastQuota" : {
"aclNum" : 10,
"aclRuleNum" : 10
},
"resPool" : {
"externalGatewayIds" : [
"00000000-0000-0000-0000-000000000001"
],
"fabricIds" : [
"00000000-0000-0000-0000-000000000002"
],
"vmmIds" : [
"00000000-0000-0000-0000-000000000003"
],
"dhcpGroupIds" : [
"00000000-0000-0000-0000-000000000004"
]
}
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.4.8.2 Query All Tenants
Typical Scenarios
Query All Tenants.
Functions
Query all tenants based on a specified condition, for example, based on the
producer. The default tenant cannot be queried. To query the public VPC and its
services, set the tenant ID to 00000000-0000-0000-0000-000000000000.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/tenants


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

dex 255
charac
ters.

iMaster NCE-Fabric

pageSi No string 0 to - Page index. "1"

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/tenants?producer=default&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-449 TenantPagedDtoWrapper parameters

eter t Value
tenant ARRAY For details, see Table Tenant -

ENCE

um ] of queried
tenants.

dex ]

ze ]

iMaster NCE-Fabric

eter t Value
id string 36 characters. - Tenant ID. This "DBB702C3-77

The value must field cannot be 19-4FE6-
meet the updated. A5AD-3A9C9E2
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 128 - Tenant name. "name"

characters.
descrip string 0 to 255 - Tenant "description"


optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.


multic boolea - false Whether the true

astCap n multicast
supported.
quota REFER For details, see Table Quota. -

ENCE 1-451.

iMaster NCE-Fabric

eter t Value
multic REFER For details, see Table Multicast -

astQuo ENCE 1-452. quota.
ta
resPool REFER For details, see Table Resource Pool -

ENCE 1-453.
Table 1-451 QuotaDto parameters

eter t Value
logicV int32 [0-2147483647 0 Quota of 10

asNum ] logical VAS
devices.
logicR int32 [0-2147483647 0 Quota of 10

outerN ] logical routers.
um
logicS int32 [0-2147483647 0 Quota of 10

witchN ] logical
um switches.
Table 1-452 MulticastQuotaDto parameters

eter t Value
aclNu int32 [0-1000] 0 Quota of ACLs. 10

m
aclRule int32 [0-3000] 0 Quota of ACL 10

Num rules.
Table 1-453 ResPoolDto parameters

eter t Value
extern array< - - External -

alGate string> Gateway Ids
wayIds

iMaster NCE-Fabric

eter t Value
fabricI array< - - Fabric Ids -

ds string>
vmmId array< - - Vmm Ids -

s string>
dhcpGr array< - - DHCP Group -

oupIds string> Ids
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenant" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40",
"quota" : {
"logicVasNum" : 10,
},
"aclNum" : 10,
"aclRuleNum" : 10
},
"resPool" : {
"00000000-0000-0000-0000-000000000001"
],
"fabricIds" : [
"00000000-0000-0000-0000-000000000002"
],
"vmmIds" : [
"00000000-0000-0000-0000-000000000003"
],
"dhcpGroupIds" : [
"00000000-0000-0000-0000-000000000004"
]
}
}
],

iMaster NCE-Fabric
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.8.3 Query a Tenant by ID
Typical Scenarios
A tenant needs to be queried by ID.
Functions
Query a tenant by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/tenants/tenant/{id}


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v3/tenants/tenant/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-455 TenantRestfulDtoWrapper parameters

eter t Value
tenant ARRAY For details, see Table Tenant -

ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenant" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40",
"quota" : {
"logicVasNum" : 10,
},
"aclNum" : 10,
"aclRuleNum" : 10
},
"resPool" : {

iMaster NCE-Fabric
"00000000-0000-0000-0000-000000000001"
],
"fabricIds" : [
"00000000-0000-0000-0000-000000000002"
],
"vmmIds" : [
"00000000-0000-0000-0000-000000000003"
],
"dhcpGroupIds" : [
"00000000-0000-0000-0000-000000000004"
]
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.8.4 Update a Tenant by ID
Typical Scenarios
Tenant information needs to be updated by ID.
Functions
Modify a tenant by ID.
Constraints
HTTP Method
PUT
URI


256 VPCs. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-443. s for
updating
a tenant.
Sample Request
HTTP
PUT /controller/dc/v3/tenants/tenant/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"tenant" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40",
"quota" : {
"logicVasNum" : 10,
},
"aclNum" : 10,
"aclRuleNum" : 10
},
"resPool" : {
"00000000-0000-0000-0000-000000000001"
],
"fabricIds" : [
"00000000-0000-0000-0000-000000000002"
],
"vmmIds" : [
"00000000-0000-0000-0000-000000000003"
],
"dhcpGroupIds" : [
"00000000-0000-0000-0000-000000000004"
]
}
}
]
}

iMaster NCE-Fabric
Response Parameters
TenantRestfulDtoWrapper parameters, For details, see Table 1-455.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenant" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40",
"quota" : {
"logicVasNum" : 10,
},
"aclNum" : 10,
"aclRuleNum" : 10
},
"resPool" : {
"00000000-0000-0000-0000-000000000001"
],
"fabricIds" : [
"00000000-0000-0000-0000-000000000002"
],
"vmmIds" : [
"00000000-0000-0000-0000-000000000003"
],
"dhcpGroupIds" : [
"00000000-0000-0000-0000-000000000004"
]
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.4.8.5 Delete a Tenant
Typical Scenarios
A tenant needs to be delete by ID.
Functions
Delete a tenant by ID.
Constraints
HTTP Method
DELETE
URI


256 an observing 19-4FE6-
charac port. A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/tenants/tenant/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.4.8.6 Query the Number of Logical NEs and Fabric Resources Used by a Tenant
Typical Scenarios
Resource statistics of a tenant need to be queried based on the tenant ID,
including the numbers of logical NEs and fabric resources used by the tenant.
Functions
Query the resource statistics of a tenant.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/tenants/tenant/{id}/statistics

iMaster NCE-Fabric


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/tenants/tenant/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/statistics HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-460 TenantAuthWrapper parameters

eter t Value
statisti REFER For details, see Table statistics -

cs ENCE 1-461.
Table 1-461 StatisticsDto parameters

eter t Value
usedFa ARRAY For details, see Table Associated -

bric _REFER 1-462. fabric resource.
ENCE
logicEl REFER For details, see Table Logical -

ement ENCE 1-463. resource
Statisti statistics.
csDto

iMaster NCE-Fabric
Table 1-462 UsedFabricDto parameters

eter t Value
fabricI string 1 to 36 - Fabric ID. "10"

d characters.
fabric string 1 to 255 - Fabric name. "10"

Name characters.
Table 1-463 LogicElementStatisticsDto parameters

eter t Value
logicN int32 [0-2147483647 0 Number of 10

etwork ] logical
Num networks.
logicR int32 [0-2147483647 0 Number of 10

outerN ] logical routers.
um
logicS int32 [0-2147483647 0 Number of 10

witchN ] logical
um switches.
logicV int32 [0-2147483647 0 Number of 10

asNum ] logical VAS
devices.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"statistics" : {
"usedFabric" : [
{
"fabricId" : "10",
"fabricName" : "10"
}

iMaster NCE-Fabric
],
"logicElementStatisticsDto" : {
"logicNetworkNum" : 10,
"logicSwitchNum" : 10,
"logicVasNum" : 10
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5 Neutron
1.9.5.1 Network
# Network operation APIs
1.9.5.1.1 Create a Network
Typical Scenarios
A network needs to be created.
Functions
Create a network.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/networks

iMaster NCE-Fabric
Request Parameters

networ Yes REFER For details, see Parameters for -

kDtoW ENCE Table 1-465. creating a
rapper network.
Table 1-465 NetworkDtoWrapper parameters

service Yes string 0 to - Cloud platform "physnet1"

_name 255 name. This
charac field cannot be
ters. updated.
networ Yes REFER For details, see Network -

k ENCE Table 1-466. information.
Table 1-466 NeutronNetworkDto parameters

name No string 0 to - Network name. "testNetwork"

255
charac
ters.
router: Yes string 0 to - Whether the "false"

extern 255 network is an
al charac external
ters. network. This
● true field cannot be
● fals updated.
e

iMaster NCE-Fabric

admin No string 0 to - Administrative "true"

_state_ 255 status.
up charac
ters.
● true
● fals
e
tenant Yes string 0 to 36 - Tenant ID. Only "00000000-000

_id charac the 0-0000-0000-0
ters. administrator 00000000005"
can specify the
tenant ID of
other tenants.
The value
cannot be
changed.
shared No string 0 to - Whether cross- "false"

255 tenant sharing
charac is supported.
ters. The default
● true value is false.
● fals
e

iMaster NCE-Fabric

id Yes string 0 to 36 - Network ID. "DBB702C3-77

charac This field 19-4FE6-
ters. cannot be A5AD-3A9C9E2
36 updated. 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
provid No string 0 to 64 - Extended "physnet1"

er:phys charac attribute: used
ical_ne ters. physical
twork network, which
must be the
same as that
configured in
the
configuration
file of the
cloud platform.
The value
physnet1 is
often used.

iMaster NCE-Fabric

provid No string 0 to - Network type, "vlan"

er:net 255 which can be
work_t charac VLAN or
ype ters. VXLAN.
provid No int32 [1-167 - Extended 10

er:seg 77215] attribute:
mentat network
ion_id segment ID.
For a VLAN
network, the
value is the
VLAN ID. For a
VXLAN
network, the
value is the
VNI.
segme No ARRAY 0-255 items. For List of -

nts _REFER details, see providers. This
ENCE Table 1-467. field is used
only by ML2-
Plugin. It
cannot coexist
with the
provider:physic
al_network,
provider:netwo
rk_type, or
provider:segme
ntation_id
attribute. A
maximum of
two segments
can be
specified.
When two
segments are
specified, the
network types
can only be set
to vxlan and
bms or vxlan
and vlan.
bindin No REFER For details, see Profile -

g:profil ENCE Table 1-468. information.
e

iMaster NCE-Fabric

qos_po No string 0 to 36 - QoS policy ID. "DBB702C3-77

licy_id charac 19-4FE6-
ters. A5AD-3A9C9E2
36 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

provid No string 0 to - Extended "physnet1"

er:phys 255 attribute: used
ical_ne charac physical
twork ters. network, which
must be the
same as that
configured in
the
configuration
file of the
cloud platform.
The value
physnet1 is
often used.
provid Yes string 0 to - Network type, "vlan"

er:net 255 which is an
work_t charac extended
ype ters. attribute. The
value can be
vlan, vxlan, or
bms.
provid No string 0 to - Extended "123"

er:seg 255 attribute:
mentat charac network
ion_id ters. segment ID.
For a VLAN
network, the
value is the
VLAN ID. For a
VXLAN
network, the
value is the
VNI.
Table 1-468 BindingProfileDto parameters

arp_mi No string 0 to - arpMiss "true"

ss 255
charac
ters.

iMaster NCE-Fabric

arp_pr No int32 [0-255 - arpProxy 0

oxy ]
bum No REFER For details, see bum -

ENCE Table 1-469.
Table 1-469 BumDto parameters

broadc No boolea ● true - Whether to false

ast_en n enable
able ● fals
e broadcast.
broadc No int64 - - Broadcast CIR. 10

ast_cir The value
_value range is from 0
to 4294967295
in Kbytes, 0 to
4294967 in
Mbytes, or 0 to
4294 in Gbytes.
broadc No string 0 to - Broadcast CIR "gbps"

ast_cir 255 unit.
_unit charac
ters.
broadc No int64 - - Broadcast CBS. 10

ast_cbs The value
_value range is from
10000 to
4294967295 in
bytes, 10 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes.
broadc No string 0 to - Broadcast CBS "mbyte(s)"

ast_cbs 255 unit.
_unit charac
ters.
multic No boolea ● true - Whether to false

ast_en n enable
able ● fals
e multicast.

iMaster NCE-Fabric

multic No int64 - - Multicast CIR. 10

ast_cir The value
_value ranges from 0
to 4294967295
in Kbytes, 0 to
4294967 in
Mbytes, or 0 to
4294 in Gbytes.
multic No string 0 to - Multicast CIR "gbps"

ast_cir 255 unit.
_unit charac
ters.
multic No int64 - - Multicast CBS. 10

ast_cbs The value
_value ranges from
10000 to
4294967295 in
bytes, 10 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes.
multic No string 0 to - Multicast CBS "mbyte(s)"

ast_cbs 255 unit.
_unit charac
ters.
unkno No boolea ● true - Whether to false

wn_uni n enable
cast_e ● fals
e unknown
nable unicast.
unkno No int64 - - Unknown 10

wn_uni unicast CIR.
cast_ci The value
r_value range is from 0
to 4294967295
in Kbytes, 0 to
4294967 in
Mbytes, or 0 to
4294 in Gbytes.
unkno No string 0 to - Unknown "gbps"

wn_uni 255 unicast CIR
cast_ci charac unit.
r_unit ters.

iMaster NCE-Fabric

unkno No int64 - - Unknown 10

wn_uni unicast CBS.
cast_cb The value
s_value range is from
10000 to
4294967295 in
bytes, 10 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes.
unkno No string 0 to - Unknown "mbyte(s)"

wn_uni 255 unicast CBS
cast_cb charac unit.
s_unit ters.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/networks HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"service_name" : "physnet1",
"network" : {
"name" : "testNetwork",
"router:external" : "false",
"admin_state_up" : "true",
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"shared" : "false",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"provider:physical_network" : "physnet1",
"provider:network_type" : "vlan",
"provider:segmentation_id" : 10,
"segments" : [
{
"provider:segmentation_id" : "123"
}
],
"binding:profile" : {
"arp_miss" : "true",
"arp_proxy" : 0,
"bum" : {
"broadcast_enable" : false,
"broadcast_cir_value" : 10,
"broadcast_cir_unit" : "gbps",
"broadcast_cbs_value" : 10,
"broadcast_cbs_unit" : "mbyte(s)",
"multicast_enable" : false,

iMaster NCE-Fabric
"multicast_cir_value" : 10,
"multicast_cir_unit" : "gbps",
"multicast_cbs_value" : 10,
"multicast_cbs_unit" : "mbyte(s)",
"unknown_unicast_enable" : false,
"unknown_unicast_cir_value" : 10,
"unknown_unicast_cir_unit" : "gbps",
"unknown_unicast_cbs_value" : 10,
"unknown_unicast_cbs_unit" : "mbyte(s)"
}
},
"qos_policy_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
}
Response Parameters

eter t Value
service string 0 to 255 - Cloud platform "physnet1"

_name characters. name. This
field cannot be
updated.
networ REFER For details, see Table Network -

k ENCE 1-471. information.
Table 1-471 NeutronNetworkDto parameters

eter t Value
name string 0 to 255 - Network name. "testNetwork"

characters.
router: string 0 to 255 - Whether the "false"

extern characters. network is an
al ● true external
● false network. This
field cannot be
updated.
admin string 0 to 255 - Administrative "true"

_state_ characters. status.
up ● true
● false

iMaster NCE-Fabric

eter t Value
tenant string 0 to 36 - Tenant ID. Only "00000000-000

_id characters. the 0-0000-0000-0
administrator 00000000005"
can specify the
tenant ID of
other tenants.
The value
cannot be
changed.
shared string 0 to 255 - Whether cross- "false"

characters. tenant sharing
● true is supported.
● false The default
value is false.
id string 0 to 36 - Network ID. "DBB702C3-77

characters. 36 This field 19-4FE6-
characters. The cannot be A5AD-3A9C9E2
value must updated. 65309"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
provid string 0 to 64 - Extended "physnet1"

er:phys characters. attribute: used
ical_ne physical
must be the
same as that
configured in
the
configuration
file of the
cloud platform.
The value
physnet1 is
often used.

iMaster NCE-Fabric

eter t Value
provid string 0 to 255 - Network type, "vlan"

er:net characters. which can be
work_t VLAN or
ype VXLAN.
provid int32 [1-16777215] - Extended 10

er:seg attribute:
mentat network
ion_id segment ID.
For a VLAN
network, the
value is the
VLAN ID. For a
VXLAN
network, the
value is the
VNI.
segme ARRAY 0-255 items. For details, List of -

nts _REFER see Table 1-472. providers. This
ENCE field is used
only by ML2-
Plugin. It
cannot coexist
with the
provider:physic
al_network,
provider:netwo
rk_type, or
provider:segme
ntation_id
attribute. A
maximum of
two segments
can be
specified.
When two
segments are
specified, the
network types
can only be set
to vxlan and
bms or vxlan
and vlan.
bindin REFER For details, see Table Profile -

g:profil ENCE 1-473. information.
e

iMaster NCE-Fabric

eter t Value
qos_po string 0 to 36 - QoS policy ID. "DBB702C3-77

licy_id characters. 36 19-4FE6-
value must 65309"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

eter t Value
provid string 0 to 255 - Extended "physnet1"

er:phys characters. attribute: used
ical_ne physical
must be the
same as that
configured in
the
configuration
file of the
cloud platform.
The value
physnet1 is
often used.
provid string 0 to 255 - Network type, "vlan"

er:net characters. which is an
work_t extended
ype attribute. The
value can be
vlan, vxlan, or
bms.

iMaster NCE-Fabric

eter t Value
provid string 0 to 255 - Extended "123"

er:seg characters. attribute:
mentat network
ion_id segment ID.
For a VLAN
network, the
value is the
VLAN ID. For a
VXLAN
network, the
value is the
VNI.
Table 1-473 BindingProfileDto parameters

eter t Value
arp_mi string 0 to 255 - arpMiss "true"

ss characters.
arp_pr int32 [0-255] - arpProxy 0

oxy
bum REFER For details, see Table bum -

ENCE 1-474.
Table 1-474 BumDto parameters

eter t Value
broadc boolea ● true - Whether to false

ast_en n enable
able ● false
broadcast.
broadc int64 - - Broadcast CIR. 10

ast_cir The value
_value range is from 0
to 4294967295
in Kbytes, 0 to
4294967 in
Mbytes, or 0 to
4294 in Gbytes.

iMaster NCE-Fabric

eter t Value
broadc string 0 to 255 - Broadcast CIR "gbps"

ast_cir characters. unit.
_unit
broadc int64 - - Broadcast CBS. 10

ast_cbs The value
_value range is from
10000 to
4294967295 in
bytes, 10 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes.
broadc string 0 to 255 - Broadcast CBS "mbyte(s)"

ast_cbs characters. unit.
_unit
multic boolea ● true - Whether to false

ast_en n enable
able ● false
multicast.
multic int64 - - Multicast CIR. 10

ast_cir The value
_value ranges from 0
to 4294967295
in Kbytes, 0 to
4294967 in
Mbytes, or 0 to
4294 in Gbytes.
multic string 0 to 255 - Multicast CIR "gbps"

ast_cir characters. unit.
_unit
multic int64 - - Multicast CBS. 10

ast_cbs The value
_value ranges from
10000 to
4294967295 in
bytes, 10 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes.
multic string 0 to 255 - Multicast CBS "mbyte(s)"

ast_cbs characters. unit.
_unit

iMaster NCE-Fabric

eter t Value
unkno boolea ● true - Whether to false

wn_uni n enable
cast_e ● false
unknown
nable unicast.
unkno int64 - - Unknown 10

wn_uni unicast CIR.
cast_ci The value
r_value range is from 0
to 4294967295
in Kbytes, 0 to
4294967 in
Mbytes, or 0 to
4294 in Gbytes.
unkno string 0 to 255 - Unknown "gbps"

wn_uni characters. unicast CIR
cast_ci unit.
r_unit
unkno int64 - - Unknown 10

wn_uni unicast CBS.
cast_cb The value
s_value range is from
10000 to
4294967295 in
bytes, 10 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes.
unkno string 0 to 255 - Unknown "mbyte(s)"

wn_uni characters. unicast CBS
cast_cb unit.
s_unit
Sample Response

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"network" : {
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"shared" : "false",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"segments" : [
{
}
],
"arp_proxy" : 0,
"bum" : {
}
},
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.1.2 Query All Networks
Typical Scenarios
All networks need to be queried.
Functions
Query all networks.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/networks

pageIn No string - - Current page "1"

dex number.
pageSi No string - - Page size. "10"

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/networks?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-476 NetworkQueryOutputDto parameters

eter t Value
networ ARRAY 0-255 items. For details, Network object -

ks _REFER see Table 1-471. list.
ENCE
numbe int32 [1-255] - Quantity. 1

r

_name characters. name.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"networks" : [
{
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"shared" : "false",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"segments" : [
{
}
],
"arp_proxy" : 0,

iMaster NCE-Fabric
"bum" : {
}
},
}
],
"number" : 1,
"service_name" : "physnet1"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.1.3 Query a Network by ID
Typical Scenarios
A network needs to be queried by ID.
Functions
Query a network by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/networks/{id}


charac 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /controller/dc/v2/neutronapi/networks/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
NetworkDtoWrapper parameters, For details, see Table 1-470.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"network" : {
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"shared" : "false",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"segments" : [
{
}
],
"arp_proxy" : 0,
"bum" : {

iMaster NCE-Fabric
}
},
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.1.4 Update a Network by ID
Typical Scenarios
A network needs to be updated by name.
Functions
Update a network by name.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric


charac 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters


kDtoW ENCE Table 1-465. updating a
rapper network.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/networks/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"network" : {
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"shared" : "false",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"segments" : [
{
}
],
"arp_proxy" : 0,
"bum" : {
}
},
}
}
Response Parameters
NetworkDtoWrapper parameters, For details, see Table 1-470.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"network" : {
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"shared" : "false",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"segments" : [
{
}
],
"arp_proxy" : 0,
"bum" : {
}
},
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.1.5 Delete a Network by ID
Typical Scenarios
A network needs to be deleted by ID. After a network is deleted, all the
corresponding subnets are deleted.
Functions
Delete a network by ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric


charac 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/networks/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.2 Subnet
# Subnet operation APIs
1.9.5.2.1 Create a Subnet
Typical Scenarios
A subnet needs to be created.
Functions
Create a subnet.
Constraints

iMaster NCE-Fabric

HTTP Method
POST
URI
/controller/dc/v2/neutronapi/subnets
Request Parameters


subnet.
Table 1-482 NeutronSubnetDtoWrapper parameters


_name 255 name.
charac
ters.
subnet Yes REFER For details, see Subnet object. -

ENCE Table 1-483.

iMaster NCE-Fabric
Table 1-483 NeutronSubnetDto parameters

id Yes string 36 - Subnet ID. This "20000000-000

charac field cannot be 0-0000-0000-0
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 0 to - Subnet name. "subnet1"

255
charac
ters.
ip_vers Yes int32 [1-255 - IP version. This 4

ion ] field cannot be
updated.
ipv6_a No string 0 to - IPv6 addressing "dhcpv6-

ddress 255 mode. stateful"
_mode charac
ters.
ipv6_ra No string 0 to - IPv6 route "dhcpv6-

_mode 255 broadcast stateful"
charac mode.
ters.

iMaster NCE-Fabric

networ Yes string 36 - Network ID. "DBB702C3-77

k_id charac This field 19-4FE6-
The updated. 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
cidr Yes string 0 to 64 - CIDR address. "192.168.10.0/2

charac This field 4"
ters. cannot be
updated.
gatew No string 0 to 64 - Gateway IP "192.168.10.1"

ay_ip charac address.
ters.
allocat No ARRAY 0-255 items. For Available IP -

ion_po _REFER details, see address pool.
ols ENCE Table 1-484.
dns_na No array< 0-255 - DNS server. ["192.168.10.1"

meserv string> items. ]
ers
host_r No ARRAY 0-255 items. For Static route of -

outes _REFER details, see a VM.
ENCE Table 1-485.

iMaster NCE-Fabric

tenant Yes string 0 to 36 - Tenant ID. This "00000000-000

_id charac field cannot be 0-0000-0000-0
enable No string 0 to - Whether to "false"

_dhcp 255 enable DHCP.
charac
ters.
● fals
e
● true
Table 1-484 NeutronSubnetAllocationPoolDto parameters

start Yes string 0 to 64 - Start IP address "192.168.10.2"

charac of a network
ters. pool.
end Yes string 0 to 64 - End IP address "192.168.10.25

charac of a network 4"
ters. pool.
Table 1-485 HostRouteDto parameters

destina No string 0 to - Destination "192.168.9.0/24

tion 255 subnet of a "
charac route.
ters.
nextho No string 0 to 64 - Next hop IP "192.168.53.1"

p charac address of a
ters. route.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/subnets HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"subnet" : {
"id" : "20000000-0000-0000-0000-000000000001",
"name" : "subnet1",
"ip_version" : 4,
"ipv6_address_mode" : "dhcpv6-stateful",
"ipv6_ra_mode" : "dhcpv6-stateful",
"network_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.10.0/24",
"gateway_ip" : "192.168.10.1",
"allocation_pools" : [
{
"start" : "192.168.10.2",
"end" : "192.168.10.254"
}
],
"dns_nameservers" : ["192.168.10.1"],
"host_routes" : [
{
"destination" : "192.168.9.0/24",
"nexthop" : "192.168.53.1"
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000004",
"enable_dhcp" : "false"
}
}
Response Parameters
Table 1-486 NeutronSubnetDtoWrapper parameters

eter t Value

subnet REFER For details, see Table Subnet object. -

ENCE 1-487.

iMaster NCE-Fabric
Table 1-487 NeutronSubnetDto parameters

eter t Value
id string 36 characters. - Subnet ID. This "20000000-000

The value must field cannot be 0-0000-0000-0
meet the updated. 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 0 to 255 - Subnet name. "subnet1"

characters.
ip_vers int32 [1-255] - IP version. This 4

ion field cannot be
updated.
ipv6_a string 0 to 255 - IPv6 addressing "dhcpv6-

ddress characters. mode. stateful"
_mode
ipv6_ra string 0 to 255 - IPv6 route "dhcpv6-

_mode characters. broadcast stateful"
mode.
networ string 36 characters. - Network ID. "DBB702C3-77

k_id The value must This field 19-4FE6-
meet the cannot be A5AD-3A9C9E2
following updated. 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
cidr string 0 to 64 - CIDR address. "192.168.10.0/2

characters. This field 4"
cannot be
updated.
gatew string 0 to 64 - Gateway IP "192.168.10.1"

ay_ip characters. address.

iMaster NCE-Fabric

eter t Value
allocat ARRAY 0-255 items. For details, Available IP -

ion_po _REFER see Table 1-488. address pool.
ols ENCE
dns_na array< 0-255 items. - DNS server. ["192.168.10.1"

meserv string> ]
ers
host_r ARRAY 0-255 items. For details, Static route of -

outes _REFER see Table 1-489. a VM.
ENCE
tenant string 0 to 36 - Tenant ID. This "00000000-000

_id characters. field cannot be 0-0000-0000-0
updated. 00000000004"
enable string 0 to 255 - Whether to "false"

_dhcp characters. enable DHCP.
● false
● true
Table 1-488 NeutronSubnetAllocationPoolDto parameters

eter t Value
start string 0 to 64 - Start IP address "192.168.10.2"

characters. of a network
pool.
end string 0 to 64 - End IP address "192.168.10.25

characters. of a network 4"
pool.
Table 1-489 HostRouteDto parameters

eter t Value
destina string 0 to 255 - Destination "192.168.9.0/24

tion characters. subnet of a "
route.
nextho string 0 to 64 - Next hop IP "192.168.53.1"

p characters. address of a
route.

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"subnet" : {
"id" : "20000000-0000-0000-0000-000000000001",
"name" : "subnet1",
"ip_version" : 4,
"cidr" : "192.168.10.0/24",
"gateway_ip" : "192.168.10.1",
{
"start" : "192.168.10.2",
"end" : "192.168.10.254"
}
],
"dns_nameservers" : ["192.168.10.1"],
"host_routes" : [
{
"destination" : "192.168.9.0/24",
"nexthop" : "192.168.53.1"
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000004",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.2.2 Query Subnets
Typical Scenarios
All subnets need to be queried.
Functions
Query all subnets.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/subnets

iMaster NCE-Fabric

networ No string 36 - Network ID. "DBB702C3-77

k_id charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/subnets?network_id=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Response status code 200: Response status code 201: Created.
Table 1-491 SubnetQueryOutputDto parameters

eter t Value
subnet ARRAY 0-255 items. For details, Subnet list. -

s _REFER see Table 1-487.
ENCE
numbe int32 [0-2147483647 - Number of 1

r ] subnets.

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"subnets" : [
{
"id" : "20000000-0000-0000-0000-000000000001",
"name" : "subnet1",
"ip_version" : 4,
"cidr" : "192.168.10.0/24",
"gateway_ip" : "192.168.10.1",
{
"start" : "192.168.10.2",
"end" : "192.168.10.254"
}
],
"dns_nameservers" : ["192.168.10.1"],

iMaster NCE-Fabric
"host_routes" : [
{
"destination" : "192.168.9.0/24",
"nexthop" : "192.168.53.1"
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000004",
}
],
"number" : 1,
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.2.3 Query a Subnet by ID
Typical Scenarios
A subnet needs to be queried by ID.
Functions
Query a subnet by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/subnets/{id}

iMaster NCE-Fabric

id Yes string 36 - Parameters for "DBB702C3-77

charac querying a 19-4FE6-
ters. subnet. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/subnets/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
NeutronSubnetDtoWrapper parameters, For details, see Table 1-486.

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"subnet" : {
"id" : "20000000-0000-0000-0000-000000000001",
"name" : "subnet1",
"ip_version" : 4,
"cidr" : "192.168.10.0/24",
"gateway_ip" : "192.168.10.1",
{
"start" : "192.168.10.2",
"end" : "192.168.10.254"
}
],
"dns_nameservers" : ["192.168.10.1"],
"host_routes" : [
{
"destination" : "192.168.9.0/24",
"nexthop" : "192.168.53.1"
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000004",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.2.4 Update a Subnet by ID
Typical Scenarios
A subnet needs to be updated by ID.
Functions
Update a subnet by ID.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes string 36 - Subnet ID "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters


ENCE Table 1-482. updating a
subnet.
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/subnets/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"subnet" : {
"id" : "20000000-0000-0000-0000-000000000001",
"name" : "subnet1",
"ip_version" : 4,
"cidr" : "192.168.10.0/24",
"gateway_ip" : "192.168.10.1",
{
"start" : "192.168.10.2",
"end" : "192.168.10.254"
}
],
"dns_nameservers" : ["192.168.10.1"],
"host_routes" : [
{
"destination" : "192.168.9.0/24",
"nexthop" : "192.168.53.1"
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000004",
}
}
Response Parameters
NeutronSubnetDtoWrapper parameters, For details, see Table 1-486.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"subnet" : {
"id" : "20000000-0000-0000-0000-000000000001",
"name" : "subnet1",
"ip_version" : 4,

iMaster NCE-Fabric
"cidr" : "192.168.10.0/24",
"gateway_ip" : "192.168.10.1",
{
"start" : "192.168.10.2",
"end" : "192.168.10.254"
}
],
"dns_nameservers" : ["192.168.10.1"],
"host_routes" : [
{
"destination" : "192.168.9.0/24",
"nexthop" : "192.168.53.1"
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000004",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.2.5 Delete a Subnet by ID
Typical Scenarios
A subnet needs to be deleted by ID.
Functions
Delete a subnet by ID.
Constraints
HTTP Method
DELETE

iMaster NCE-Fabric
URI

id Yes string 36 - Subnet ID "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/subnets/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.3 Port
# Port operation APIs
1.9.5.3.1 Create a Port
Typical Scenarios
A port needs to be created.
Functions
Create a port.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/ports
Request Parameters

Neutro Yes REFER For details, see Parameters for -

nportD ENCE Table 1-497. creating a port.
toWra
pper
Table 1-497 NeutronPortDtoWrapper parameters

port Yes REFER For details, see Port -


ters. updated.
Table 1-498 NeutronPortDto parameters

name No string 0 to - Port name. "test_name"

255
charac
ters.

iMaster NCE-Fabric

id Yes string 0 to 36 - UUID. This field "DBB702C3-77

charac cannot be 19-4FE6-
36 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

networ Yes string 0 to 36 - Network ID. "DBB702C3-77

k_id charac This field 19-4FE6-
36 updated. 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
mac_a Yes string 0 to 32 - Port MAC "fa:16:3e:9e:ff:

ddress charac address. If 55"
ters. device_owner
is set to
network:router
_interface, the
input value
does not take
effect, and the
controller sets
this parameter
to a fixed MAC
address.
fixed_i No ARRAY 0-255 items. For IP address of a -

ps _REFER details, see port.
ENCE Table 1-499.

iMaster NCE-Fabric

device_ No string 0 to 36 - ID of the "40000000-111

id charac device that 1-0000-0000-0
ters. uses the port. 00000099001"
The value of
this parameter
depends on the
value of
device_owner.
For example, if
device_owner
is set to
network:router
_gateway or
network:router
_interface, this
parameter
needs to be set
to a logical
router ID; if
device_owner
is set to
compute:nova
or
network:dhcp,
this parameter
needs to be set
to a device ID.
device_ No string 0 to - Type of the "compute:nova

owner 255 object to which "
charac the port
ters. belongs. The
value can be a
VM
(compute:nova
), router
(network:route
r_interface),
DHCP server
(network:dhcp)
, routing
gateway
(network:route
r_gateway), or
load balancer
(neutron:LOAD
BALANCER).

iMaster NCE-Fabric

tenant Yes string 0 to 36 - Tenant ID. This "14c6bc47-5a5

_id charac field cannot be c-47da-
ters. updated. bff3-7ed2b0ca
8c8f"
status No string 0 to - Port status. "ACTIVE"

255
charac
ters.
bindin No string 0 to 64 - Extended "normal"

g:vif_ty charac attribute: VIF
pe ters. type.
bindin No string 0 to - Detailed "details"

g:vif_d 255 information
etails charac about a VIF.
ters.
bindin No string 0 to - Extended "compute-192.

g:host_ 255 attribute: host 168.8.161"
id charac ID. In the
ters. distributed
hybrid overlay
solution, this
parameter is
mandatory and
the value is the
ID of the
CE1800V. In
the network
overlay
solution, this
parameter is
optional and
the value is the
host name of
the compute
node where
the VM is
located.
bindin No REFER For details, see Profile -

g:profil ENCE Table 1-500. information.
e

iMaster NCE-Fabric

port_se No string 0 to - Extended "true"

curity_ 255 attribute:
enable charac whether the
d ters. port supports
● true security
● fals groups.
e
securit No array< 0-255 - Extended ["00000000-00

y_grou string> items. attribute: UUID 00-0000-2222-
ps Each of a security 000000000001
item group. "]
has 0
to 36
charac
ters.
allowe No ARRAY 0-255 items. For Extended -

d_addr _REFER details, see attributed: IP
ess_pai ENCE Table 1-502. address or
rs MAC address
pair list.
extra_d No ARRAY 0-255 items. For Extended -

hcp_op _REFER details, see attribute:
ts ENCE Table 1-503. extended
option of
DHCP.
bindin No string 0 to 64 - Type of the "normal"

g:vnic_ charac bound vNIC.
type ters.
qos_po No string 0 to 36 - QoS policy ID. "DBB702C3-77

licy_id charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
device_ No string 0 to 64 - Physical switch, "123"

group_ charac firewall, or LB
id ters. group ID.
interfa No string 0 to - Physical device "123"

ce_id 255 port ID. It is a
charac backfilling
ters. attribute.

iMaster NCE-Fabric

trunkp No string 0 to - Trunk port "trunk"

ort:typ 255 type. If the
e charac value is left
ters. empty, the
original port
type is used.
The value
trunk indicates
a trunk port
and the value
subport
indicates a
subport of a
trunk port.
Other
unidentified
values are
processed as
the original
port type.
trunkp No string 0 to 36 - ID of a trunk "123"

ort:par charac interface when
ent_id ters. the port type is
subport.
trunkp No int32 0 to - VLAN ID 10

ort:vid 21474 allowed by a
83647 trunk interface
charac when the port
ters. type is subport.
[1-214
74836
47]

_state_ 255 status.
up charac
ters.
mtu No string 0 to - Maximum "1500"

65536 transmission
charac unit.
ters.
trunkD No REFER For details, see Trunk details. -

etails ENCE Table 1-504.

iMaster NCE-Fabric
Table 1-499 FixedIpDto parameters

subnet No string 0 to 36 - Subnet ID "DBB702C3-77

_id charac 19-4FE6-
ters. A5AD-3A9C9E2
36 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
ip_add No string 0 to 64 - IP address. "192.168.73.16

ress charac "
ters.
Table 1-500 BindProfileDto parameters

migrati No string 0 to - ID or name of "testHost"

ng_hos 255 the host to
t charac which the VM
ters. is migrated.

iMaster NCE-Fabric

migrati No string 0 to - VM migration "ACTIVE"

ng_sta 255 status.
tus charac
ters.
extern No string 0 to - External VLAN. "vlan1"

al_vlan 255
charac
ters.
local_li No ARRAY 0-255 items. For Local link -

nk_inf _REFER details, see information.
ormati ENCE Table 1-501.
on
Table 1-501 LocalLinkInformationDto parameters

switch No string 0 to 36 - Switch ID. "00000000-000

_id charac 0-0000-0000-0
ters. 00000000002"
mgmtI No string 0 to 64 - Migrated IP "192.168.5.3"

P charac address.
ters.
port_id No string 0 to 36 - Port ID. "00000000-000

charac 0-0000-0000-0
ters. 00000000003"
switch No string 0 to - Switch "123"

_info 255 information.
charac
ters.
Table 1-502 AddressPairDto parameters

mac_a No string 0 to 64 - MAC address. "fa:16:3e:9e:ff:

ddress charac 55"
ters.

iMaster NCE-Fabric

ip_add No string 0 to 64 - IP address, "192.168.1.1"

ress charac which cannot
ters. be empty.
Table 1-503 DHCPOptionDto parameters

id No string 0 to 36 - Option ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
opt_na No string 0 to - Option name. "test"

me 255
charac
ters.

iMaster NCE-Fabric

opt_val No string 0 to - Option value. "testValue"

ue 255
charac
ters.
Table 1-504 TrunkDetailDto parameters

trunk_i No string 0 to 36 - Trunk ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
sub_po No ARRAY 0-255 items. For Sub-interface -

rts _REFER details, see of a trunk
ENCE Table 1-505. interface.

iMaster NCE-Fabric
Table 1-505 SubPortDto parameters

segme No int32 [2-409 - Segmentation 10

ntation 4] ID.
_id
port_id No string 0 to 36 - Sub-interface "DBB702C3-77

charac ID. 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
segme No string 0 to 10 - Network type. "vlan"

ntation charac
_type ters.
mac_a No string 0 to 64 - MAC address. "00-FF-9E-8B-

ddress charac FF-26"
ters.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/ports HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"port" : {
"name" : "test_name",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"mac_address" : "fa:16:3e:9e:ff:55",
"fixed_ips" : [
{
"subnet_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"ip_address" : "192.168.73.16"
}
],
"device_id" : "40000000-1111-0000-0000-000000099001",
"device_owner" : "compute:nova",
"tenant_id" : "14c6bc47-5a5c-47da-bff3-7ed2b0ca8c8f",
"status" : "ACTIVE",
"binding:vif_type" : "normal",
"binding:vif_details" : "details",
"binding:host_id" : "compute-192.168.8.161",
"migrating_host" : "testHost",
"migrating_status" : "ACTIVE",
"external_vlan" : "vlan1",
"local_link_information" : [
{
"switch_id" : "00000000-0000-0000-0000-000000000002",
"mgmtIP" : "192.168.5.3",
"port_id" : "00000000-0000-0000-0000-000000000003",
"switch_info" : "123"
}
]
},
"port_security_enabled" : "true",
"security_groups" : ["00000000-0000-0000-2222-000000000001"],
"allowed_address_pairs" : [
{
"ip_address" : "192.168.1.1"
}
],
"extra_dhcp_opts" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
"opt_name" : "test",
"opt_value" : "testValue"
}
],
"binding:vnic_type" : "normal",
"qos_policy_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"device_group_id" : "123",
"interface_id" : "123",
"trunkport:type" : "trunk",
"trunkport:parent_id" : "123",
"trunkport:vid" : 10,
"mtu" : "1500",
"trunkDetails" : {
"trunk_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
"sub_ports" : [
{
"segmentation_id" : 10,
"port_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
"segmentation_type" : "vlan",

iMaster NCE-Fabric
"mac_address" : "00-FF-9E-8B-FF-26"
}
]
}
},
}
Response Parameters
Table 1-506 NeutronPortDtoWrapper parameters

eter t Value
port REFER For details, see Table Port -


field cannot be
updated.
Table 1-507 NeutronPortDto parameters

eter t Value
name string 0 to 255 - Port name. "test_name"

characters.
id string 0 to 36 - UUID. This field "DBB702C3-77

characters. 36 cannot be 19-4FE6-
characters. The updated. A5AD-3A9C9E2
value must 65309"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
networ string 0 to 36 - Network ID. "DBB702C3-77

k_id characters. 36 This field 19-4FE6-
characters. The cannot be A5AD-3A9C9E2
value must updated. 65309"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
mac_a string 0 to 32 - Port MAC "fa:16:3e:9e:ff:

ddress characters. address. If 55"
device_owner
is set to
network:router
_interface, the
input value
does not take
effect, and the
controller sets
this parameter
to a fixed MAC
address.
fixed_i ARRAY 0-255 items. For details, IP address of a -

ps _REFER see Table 1-508. port.
ENCE

iMaster NCE-Fabric

eter t Value
device_ string 0 to 36 - ID of the "40000000-111

id characters. device that 1-0000-0000-0
uses the port. 00000099001"
The value of
this parameter
depends on the
value of
device_owner.
For example, if
device_owner
is set to
network:router
_gateway or
network:router
_interface, this
parameter
needs to be set
to a logical
router ID; if
device_owner
is set to
compute:nova
or
network:dhcp,
this parameter
needs to be set
to a device ID.
device_ string 0 to 255 - Type of the "compute:nova

owner characters. object to which "
the port
belongs. The
value can be a
VM
(compute:nova
), router
(network:route
r_interface),
DHCP server
(network:dhcp)
, routing
gateway
(network:route
r_gateway), or
load balancer
(neutron:LOAD
BALANCER).

iMaster NCE-Fabric

eter t Value
tenant string 0 to 36 - Tenant ID. This "14c6bc47-5a5

_id characters. field cannot be c-47da-
updated. bff3-7ed2b0ca
8c8f"
status string 0 to 255 - Port status. "ACTIVE"

characters.
bindin string 0 to 64 - Extended "normal"

g:vif_ty characters. attribute: VIF
pe type.
bindin string 0 to 255 - Detailed "details"

g:vif_d characters. information
etails about a VIF.
bindin string 0 to 255 - Extended "compute-192.

g:host_ characters. attribute: host 168.8.161"
id ID. In the
distributed
hybrid overlay
solution, this
parameter is
mandatory and
the value is the
ID of the
CE1800V. In
the network
overlay
solution, this
parameter is
optional and
the value is the
host name of
the compute
node where
the VM is
located.
bindin REFER For details, see Table Profile -

g:profil ENCE 1-509. information.
e
port_se string 0 to 255 - Extended "true"

curity_ characters. attribute:
enable ● true whether the
d port supports
● false
security
groups.

iMaster NCE-Fabric

eter t Value
securit array< 0-255 items. - Extended ["00000000-00

y_grou string> Each item has 0 attribute: UUID 00-0000-2222-
ps to 36 of a security 000000000001
characters. group. "]
allowe ARRAY 0-255 items. For details, Extended -

d_addr _REFER see Table 1-511. attributed: IP
ess_pai ENCE address or
rs MAC address
pair list.
extra_d ARRAY 0-255 items. For details, Extended -

hcp_op _REFER see Table 1-512. attribute:
ts ENCE extended
option of
DHCP.
bindin string 0 to 64 - Type of the "normal"

g:vnic_ characters. bound vNIC.
type
qos_po string 0 to 36 - QoS policy ID. "DBB702C3-77

licy_id characters. 19-4FE6-
A5AD-3A9C9E2
65309"
device_ string 0 to 64 - Physical switch, "123"

group_ characters. firewall, or LB
id group ID.
interfa string 0 to 255 - Physical device "123"

ce_id characters. port ID. It is a
backfilling
attribute.

iMaster NCE-Fabric

eter t Value
trunkp string 0 to 255 - Trunk port "trunk"

ort:typ characters. type. If the
e value is left
empty, the
original port
type is used.
The value
trunk indicates
a trunk port
and the value
subport
indicates a
subport of a
trunk port.
Other
unidentified
values are
processed as
the original
port type.
trunkp string 0 to 36 - ID of a trunk "123"

ort:par characters. interface when
ent_id the port type is
subport.
trunkp int32 0 to - VLAN ID 10

ort:vid 2147483647 allowed by a
characters. trunk interface
[1-2147483647 when the port
] type is subport.

up
mtu string 0 to 65536 - Maximum "1500"

characters. transmission
unit.
trunkD REFER For details, see Table Trunk details. -

etails ENCE 1-513.

iMaster NCE-Fabric

eter t Value
subnet string 0 to 36 - Subnet ID "DBB702C3-77

_id characters. 36 19-4FE6-
value must 65309"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
ip_add string 0 to 64 - IP address. "192.168.73.16

ress characters. "
Table 1-509 BindProfileDto parameters

eter t Value
migrati string 0 to 255 - ID or name of "testHost"

ng_hos characters. the host to
t which the VM
is migrated.
migrati string 0 to 255 - VM migration "ACTIVE"

ng_sta characters. status.
tus
extern string 0 to 255 - External VLAN. "vlan1"

al_vlan characters.
local_li ARRAY 0-255 items. For details, Local link -

nk_inf _REFER see Table 1-510. information.
ormati ENCE
on

iMaster NCE-Fabric
Table 1-510 LocalLinkInformationDto parameters

eter t Value
switch string 0 to 36 - Switch ID. "00000000-000

_id characters. 0-0000-0000-0
00000000002"
mgmtI string 0 to 64 - Migrated IP "192.168.5.3"

P characters. address.
port_id string 0 to 36 - Port ID. "00000000-000

00000000003"
switch string 0 to 255 - Switch "123"

_info characters. information.
Table 1-511 AddressPairDto parameters

eter t Value
mac_a string 0 to 64 - MAC address. "fa:16:3e:9e:ff:

ddress characters. 55"
ip_add string 0 to 64 - IP address, "192.168.1.1"

ress characters. which cannot
be empty.
Table 1-512 DHCPOptionDto parameters

eter t Value
id string 0 to 36 - Option ID. "DBB702C3-77

value must 60001"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
opt_na string 0 to 255 - Option name. "test"

me characters.
opt_val string 0 to 255 - Option value. "testValue"

ue characters.
Table 1-513 TrunkDetailDto parameters

eter t Value
trunk_i string 0 to 36 - Trunk ID. "DBB702C3-77

d characters. 36 19-4FE6-
value must 60001"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
sub_po ARRAY 0-255 items. For details, Sub-interface -

rts _REFER see Table 1-514. of a trunk
ENCE interface.
Table 1-514 SubPortDto parameters

eter t Value
segme int32 [2-4094] - Segmentation 10

ntation ID.
_id

iMaster NCE-Fabric

eter t Value
port_id string 0 to 36 - Sub-interface "DBB702C3-77

characters. 36 ID. 19-4FE6-
value must 60001"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
segme string 0 to 10 - Network type. "vlan"

ntation characters.
_type
mac_a string 0 to 64 - MAC address. "00-FF-9E-8B-

ddress characters. FF-26"
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{
"ip_address" : "192.168.73.16"
}
],
"device_id" : "40000000-1111-0000-0000-000000099001",

iMaster NCE-Fabric
{
"switch_id" : "00000000-0000-0000-0000-000000000002",
"mgmtIP" : "192.168.5.3",
"port_id" : "00000000-0000-0000-0000-000000000003",
}
]
},
"security_groups" : ["00000000-0000-0000-2222-000000000001"],
{
"ip_address" : "192.168.1.1"
}
],
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
}
],
"mtu" : "1500",
"trunkDetails" : {
"sub_ports" : [
{
}
]
}
},
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Typical Scenarios
Functions
Query all ports.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/ports

iMaster NCE-Fabric

networ No string 0 to 36 - Network ID. "DBB702C3-77

ters. A5AD-3A9C9E2
36 65309"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/ports?network_id=DBB702C3-7719-4FE6-
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-516 PortQueryOutputDto parameters

eter t Value
ports ARRAY 0-255 items. For details, Port list. -

_REFER see Table 1-507.
ENCE

r ] ports in a list.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ports" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{
"ip_address" : "192.168.73.16"
}
],
"device_id" : "40000000-1111-0000-0000-000000099001",

iMaster NCE-Fabric
{
"switch_id" : "00000000-0000-0000-0000-000000000002",
"mgmtIP" : "192.168.5.3",
"port_id" : "00000000-0000-0000-0000-000000000003",
}
]
},
"security_groups" : ["00000000-0000-0000-2222-000000000001"],
{
"ip_address" : "192.168.1.1"
}
],
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
}
],
"mtu" : "1500",
"trunkDetails" : {
"sub_ports" : [
{
}
]
}
}
],
"number" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.3.3 Query a Port by ID
Typical Scenarios
Query a Port by ID.
Functions
Query a port by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/ports/{id}

iMaster NCE-Fabric

id Yes string 0 to 36 - Port ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/ports/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
NeutronPortDtoWrapper parameters, For details, see Table 1-506.
the parameter type or value range is incorrect. example, the parameter type or
value range is incorrect.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{
"ip_address" : "192.168.73.16"
}
],
"device_id" : "40000000-1111-0000-0000-000000099001",
{
"switch_id" : "00000000-0000-0000-0000-000000000002",
"mgmtIP" : "192.168.5.3",
"port_id" : "00000000-0000-0000-0000-000000000003",
}
]
},
"security_groups" : ["00000000-0000-0000-2222-000000000001"],
{
"ip_address" : "192.168.1.1"
}
],

iMaster NCE-Fabric
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
}
],
"mtu" : "1500",
"trunkDetails" : {
"sub_ports" : [
{
}
]
}
},
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.3.4 Update a Port by ID
Typical Scenarios
A port needs to be deleted by ID.
Functions
Update a port by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
PUT
URI


charac 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric
Request Parameters

Neutro Yes REFER For details, see Parameters for -

nportD ENCE Table 1-497. updating a
toWra port.
pper
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/ports/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"port" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{
"ip_address" : "192.168.73.16"
}
],
"device_id" : "40000000-1111-0000-0000-000000099001",
{
"switch_id" : "00000000-0000-0000-0000-000000000002",
"mgmtIP" : "192.168.5.3",
"port_id" : "00000000-0000-0000-0000-000000000003",
}
]
},
"security_groups" : ["00000000-0000-0000-2222-000000000001"],
{
"ip_address" : "192.168.1.1"
}
],

iMaster NCE-Fabric
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
}
],
"mtu" : "1500",
"trunkDetails" : {
"sub_ports" : [
{
}
]
}
},
}
Response Parameters
NeutronPortDtoWrapper parameters, For details, see Table 1-506.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{

iMaster NCE-Fabric
"ip_address" : "192.168.73.16"
}
],
"device_id" : "40000000-1111-0000-0000-000000099001",
{
"switch_id" : "00000000-0000-0000-0000-000000000002",
"mgmtIP" : "192.168.5.3",
"port_id" : "00000000-0000-0000-0000-000000000003",
}
]
},
"security_groups" : ["00000000-0000-0000-2222-000000000001"],
{
"ip_address" : "192.168.1.1"
}
],
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E260001",
}
],
"mtu" : "1500",
"trunkDetails" : {
"sub_ports" : [
{
}
]
}
},
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.3.5 Delete a Port by ID
Typical Scenarios
Functions
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric


charac 19-4FE6-
ters. A5AD-3A9C9E2
36 60001"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/ports/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.4 Router
# Router operation APIs
1.9.5.4.1 Create a Router
Typical Scenarios
A router needs to be created.
Functions
Create a router.

iMaster NCE-Fabric
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/routers
Request Parameters

router Yes REFER For details, see Router. -

DtoWr ENCE Table 1-522.
apper
Table 1-522 RouterDtoWrapper parameters


_name 255 name.
charac
ters.
router Yes REFER For details, see Router -


iMaster NCE-Fabric
Table 1-523 RouterDto parameters

id Yes string 36 - Router ID. This "DBB702C3-77

The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 0 to - Router name. "router1"

255
charac
ters.

_state_ 255 status.
up charac
ters.
● true
● fals
e
status No string 0 to - Router status. "ACTIVE"

255
charac
ters.

iMaster NCE-Fabric


_id charac field cannot be 0-0000-
ters. updated. abce-00000000
0001"
extern No REFER For details, see External -

al_gate ENCE Table 1-524. gateway
way_in information.
fo
routes No ARRAY 0-255 items. For Route, which is -

_REFER details, see configured
ENCE Table 1-525. using the
routes
interface.
When a router
is created or
modified, do
not set this
parameter.
vpn- No string 0 to - VPN instance "vpn1"

instanc 255 name. This
e charac field cannot be
ters. updated.
provid No int64 [1-160 - L3VNI value. 10

er:seg 00000] This field
mentat cannot be
ion_id updated.
provid No string 0 to - Export RT of a "3:1000"

er:vrf_r 255 VRF.
t_expo charac
rt ters.
provid No array< 0-255 - Import RT of a ["3:1000"]

er:vrf_r string> items. VRF.
t_impo
rt

iMaster NCE-Fabric

port_id No string 36 - Gateway port "00000000-000

charac ID. 0-0000-3222-0
ters. 00000000003"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
enable No string 0 to 5 - Whether to "false"

d_snat charac enable global
ters. SNAT.
● true
● fals
e
Table 1-525 RouteDto parameters

destina No string 0 to 64 - Destination "192.168.2.0/24

tion charac address. "
ters.

iMaster NCE-Fabric

nextho No string 0 to 64 - Next hop. "192.168.2.2"

p charac
ters.
track_t No string 0 to 16 - Track type. "share-bfd"

ype charac
ters.
port_id No string 36 - VM port ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/routers HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"name" : "router1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"external_gateway_info" : {
"port_id" : "00000000-0000-0000-3222-000000000003",
"enabled_snat" : "false"
},
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
"track_type" : "share-bfd",
"port_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
],
"vpn-instance" : "vpn1",
"provider:vrf_rt_export" : "3:1000",
"provider:vrf_rt_import" : ["3:1000"]
}
}
Response Parameters
Table 1-526 RouterDtoWrapper parameters

eter t Value

router REFER For details, see Table Router -

Table 1-527 RouterDto parameters

eter t Value
id string 36 characters. - Router ID. This "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
name string 0 to 255 - Router name. "router1"

characters.

up ● true
● false
status string 0 to 255 - Router status. "ACTIVE"

characters.

_id characters. field cannot be 0-0000-
updated. abce-00000000
0001"
extern REFER For details, see Table External -

al_gate ENCE 1-528. gateway
way_in information.
fo
routes ARRAY 0-255 items. For details, Route, which is -

_REFER see Table 1-529. configured
ENCE using the
routes
interface.
When a router
is created or
modified, do
not set this
parameter.
vpn- string 0 to 255 - VPN instance "vpn1"

instanc characters. name. This
e field cannot be
updated.
provid int64 [1-16000000] - L3VNI value. 10

er:seg This field
mentat cannot be
ion_id updated.
provid string 0 to 255 - Export RT of a "3:1000"

er:vrf_r characters. VRF.
t_expo
rt
provid array< 0-255 items. - Import RT of a ["3:1000"]

er:vrf_r string> VRF.
t_impo
rt

iMaster NCE-Fabric

eter t Value
port_id string 36 characters. - Gateway port "00000000-000

The value must ID. 0-0000-3222-0
meet the 00000000003"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
enable string 0 to 5 - Whether to "false"

d_snat characters. enable global
● true SNAT.
● false
Table 1-529 RouteDto parameters

eter t Value
destina string 0 to 64 - Destination "192.168.2.0/24

tion characters. address. "
nextho string 0 to 64 - Next hop. "192.168.2.2"

p characters.
track_t string 0 to 16 - Track type. "share-bfd"

ype characters.
port_id string 36 characters. - VM port ID. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "router1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"port_id" : "00000000-0000-0000-3222-000000000003",
},
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
],
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.4.2 Query All Routers
Typical Scenarios
All routers need to be queried.
Functions
Query all routers.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/routers


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/routers?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-531 RouterQueryOutputDto parameters

eter t Value
routers ARRAY 0-255 items. For details, Router -

ENCE
numbe int32 [0-2147483647 - Quantity. 1

r ]

Name characters. name.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routers" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "router1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"port_id" : "00000000-0000-0000-3222-000000000003",
},
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
],

iMaster NCE-Fabric
}
],
"number" : 1,
"serviceName" : "physnet1"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.4.3 Query a Router by ID
Typical Scenarios
A router needs to be queried by ID.
Functions
Query a router by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/routers/{id}

iMaster NCE-Fabric

id Yes string 36 - Router ID. "00000000-000

charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
RouterDtoWrapper parameters, For details, see Table 1-526.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "router1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"port_id" : "00000000-0000-0000-3222-000000000003",
},
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
],
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.4.4 Update a Router
Typical Scenarios
A router needs to be updated by ID.
Functions
Update a router by ID.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric


charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

router Yes REFER For details, see Router. -

apper
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "router1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"port_id" : "00000000-0000-0000-3222-000000000003",
},
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
],
}
}
Response Parameters
RouterDtoWrapper parameters, For details, see Table 1-526.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "router1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",

iMaster NCE-Fabric
"port_id" : "00000000-0000-0000-3222-000000000003",
},
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
],
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.4.5 Delete a Router by ID
Typical Scenarios
A router needs to be deleted by ID.
Functions
Delete a router by ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric


charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.4.6 Create a Router Link
Typical Scenarios
A router link needs to be created.
Functions
Create a router link.
Constraints
HTTP Method
PUT

iMaster NCE-Fabric
URI
/controller/dc/v2/neutronapi/routers/{id}/add_links


charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

routerli Yes REFER For details, see Router link. -

nkDto ENCE Table 1-538.
Wrapp
er

iMaster NCE-Fabric
Table 1-538 RouterLinkDtoWrapper parameters

links Yes ARRAY 0-255 items. For Router link. -

_REFER details, see
ENCE Table 1-539.
Table 1-539 RouterLinkDto parameters

name No string 0 to - Router link "link"

255 name.
charac
ters.
peer_r No string 36 - Peer router ID. "00000000-000

outer_i charac 0-0000-1234-0
d ters. 00000000002"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
peer_v No string 0 to - RT of the peer "1:1"

rf_rt 255 VRF.
charac
ters.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001/add_links HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"links" : [
{
"name" : "link",
"peer_router_id" : "00000000-0000-0000-1234-000000000002",
"peer_vrf_rt" : "1:1"
}
]
}
Response Parameters
Table 1-540 RouterLinkDtoWrapper parameters

eter t Value
links ARRAY 0-255 items. For details, Router link. -

ENCE
Table 1-541 RouterLinkDto parameters

eter t Value
name string 0 to 255 - Router link "link"

characters. name.
peer_r string 36 characters. - Peer router ID. "00000000-000

outer_i The value must 0-0000-1234-0
d meet the 00000000002"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
peer_v string 0 to 255 - RT of the peer "1:1"

rf_rt characters. VRF.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"links" : [
{
"name" : "link",
"peer_router_id" : "00000000-0000-0000-1234-000000000002",
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.4.7 Add a Route by Router ID
Typical Scenarios
A route needs to be added by router ID.

iMaster NCE-Fabric
Functions
Add a route by router ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/routers/{id}/add_routes


charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric
Request Parameters

routes Yes REFER For details, see Route. -

apper
Table 1-544 RoutesDtoWrapper parameters

routes Yes ARRAY 0-255 items. For Route. -

_REFER details, see
ENCE Table 1-525.
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001/add_routes HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
]
}
Response Parameters

iMaster NCE-Fabric

eter t Value
routes ARRAY 0-255 items. For details, Route. -

ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.4.8 Query a Router Link by Router ID
Typical Scenarios
A router link needs to be queried by router ID.
Functions
Query a router link by router ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/routers/{id}/query_links

iMaster NCE-Fabric


charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001/query_links HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-547 RouterLinkQueryOutputDto parameters

eter t Value
links ARRAY 0-255 items. For details, Router link. -

ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"links" : [
{
"name" : "link",
"peer_router_id" : "00000000-0000-0000-1234-000000000002",
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.4.9 Delete a Router Link by Router ID
Typical Scenarios
A router link needs to be deleted by router ID.
Functions
Delete a router link by router ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/routers/{id}/remove_links

iMaster NCE-Fabric


charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

routerL Yes REFER For details, see Router link. -

inkDto ENCE Table 1-538.
Wrapp
er
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001/remove_links HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"links" : [
{
"name" : "link",
"peer_router_id" : "00000000-0000-0000-1234-000000000002",
}
]
}
Response Parameters
RouterLinkDtoWrapper parameters, For details, see Table 1-540.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"links" : [
{
"name" : "link",
"peer_router_id" : "00000000-0000-0000-1234-000000000002",
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.4.10 Delete a Route by Router ID
Typical Scenarios
A route needs to be deleted by router ID.
Functions
Delete a route by router ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/routers/{id}/remove_routes

iMaster NCE-Fabric


charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

routes Yes REFER For details, see Parameters for -

DtoWr ENCE Table 1-544. deleting a
apper route.
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001/remove_routes HTTP/
1.1

iMaster NCE-Fabric
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
]
}
Response Parameters
RoutesDtoWrapper parameters, For details, see Table 1-545.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.4.11 Query a Static Route by Router ID
Typical Scenarios
Static route information needs to be queried based on the router ID.
Functions
Query a static route by router ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/routers/{id}/query_staticrouters

iMaster NCE-Fabric


charac 0-0000-1234-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/routers/00000000-0000-0000-1234-000000000001/query_staticrouters
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
RoutesDtoWrapper parameters, For details, see Table 1-545.

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routes" : [
{
"destination" : "192.168.2.0/24",
"nexthop" : "192.168.2.2",
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.5 Internal Router APIs

# Internal router interface operation APIs
1.9.5.5.1 Create an Internal Router Interface by ID
Typical Scenarios
An internal router interface needs to be created by ID.
This API is retained to maintain compatibility and does not implement any
function. Instead, the function is implemented by the API for deleting ports.

iMaster NCE-Fabric
Functions
Create an internal router interface by ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/routerinterface/{router_id}/add_router_interface

router_ Yes uuid - - Router ID. "00000000-000

id 0-0000-1234-0
00000000001"
Request Parameters

routerI Yes REFER For details, see Router -

nterfac ENCE Table 1-555. interface.
eDto
Table 1-555 RouterInterfaceDto parameters

port_id Yes string 0 to 36 - Port ID. "00000000-000

charac 0-0000-0000-0
ters. 00000000009"

iMaster NCE-Fabric

subnet Yes string 0 to 36 - Subnet ID. "00000000-000

_id charac 0-0000-0000-0
ters. 00000000003"
tenant Yes string 0 to - Tenant ID. "00000000-000

_id 255 0-0000-0000-0
charac 00000000001"
ters.
id Yes string 0 to 36 - Route ID. "00000000-000

charac 0-0000-0000-0
ters. 00000000002"

_name 255 name.
charac
ters.
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/routerinterface/00000000-0000-0000-1234-000000000001/
add_router_interface HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"port_id" : "00000000-0000-0000-0000-000000000009",
"subnet_id" : "00000000-0000-0000-0000-000000000003",
"tenant_id" : "00000000-0000-0000-0000-000000000001",
"id" : "00000000-0000-0000-0000-000000000002",
}
Response Parameters
Table 1-556 RouterInterfaceDto parameters

eter t Value
port_id string 0 to 36 - Port ID. "00000000-000

00000000009"

iMaster NCE-Fabric

eter t Value
subnet string 0 to 36 - Subnet ID. "00000000-000

00000000003"
tenant string 0 to 255 - Tenant ID. "00000000-000

00000000001"
id string 0 to 36 - Route ID. "00000000-000

00000000002"

Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port_id" : "00000000-0000-0000-0000-000000000009",
"subnet_id" : "00000000-0000-0000-0000-000000000003",
"tenant_id" : "00000000-0000-0000-0000-000000000001",
"id" : "00000000-0000-0000-0000-000000000002",
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.5.2 Query Sunbet IDs
Typical Scenarios
A subnet ID needs to be queried by ID.
Functions
Query the subnet ID of internal interfaces by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/routerinterface/{router_id}/query_subnet_ids

router_ Yes uuid - - Subnet ID for "00000000-000

id querying 0-0000-1234-0
internal 00000000001"
interfaces.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/routerinterface/00000000-0000-0000-1234-000000000001/
query_subnet_ids HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-558 QuerySubnetIdsOutputDto parameters

eter t Value
subNet ARRAY 0-255 items. For details, subnetIdDtos -

DtoIds _REFER see Table 1-559.
ENCE
Table 1-559 SubnetIdDto parameters

eter t Value
subnet uuid - - Subnet ID "DBB702C3-77

_id 19-4FE6-
A5AD-3A9C9E2
65309"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"subNetDtoIds" : [
{
"subnet_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.5.3 Delete an Internal Router Interface by ID
Typical Scenarios
A router interface needs to be deleted by ID.
This API is retained to maintain compatibility and does not implement any
function. Instead, the function is implemented by the API for deleting ports.
Functions
Delete an internal router interface by ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/routerinterface/{router_id}/remove_router_interface

router_ Yes uuid - - router id. "00000000-000

id 0-0000-1234-0
00000000001"
Request Parameters

body Yes REFER For details, see Router -

ENCE Table 1-555. interface.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/routerinterface/00000000-0000-0000-1234-000000000001/
remove_router_interface HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"port_id" : "00000000-0000-0000-0000-000000000009",
"subnet_id" : "00000000-0000-0000-0000-000000000003",
"tenant_id" : "00000000-0000-0000-0000-000000000001",
"id" : "00000000-0000-0000-0000-000000000002",
}
Response Parameters
RouterInterfaceDto parameters, For details, see Table 1-556.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port_id" : "00000000-0000-0000-0000-000000000009",
"subnet_id" : "00000000-0000-0000-0000-000000000003",
"tenant_id" : "00000000-0000-0000-0000-000000000001",
"id" : "00000000-0000-0000-0000-000000000002",
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.6 Snat
1.9.5.6.1 Create SNAT
Typical Scenarios
The SNAT needs to be created.
Functions
Create SNAT.
Constraints
HTTP Method
POST
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/snats
Request Parameters

er Range Value on
input REFERE For details, see Table SNAT -

NCE 1-563. entity to
be
created.

iMaster NCE-Fabric
Table 1-563 snats parameters

snat No ARRAY For details, see snat -

_REFER Table 1-564.
ENCE
Table 1-564 snat-wrapper parameters

uuid Yes string 36 - SNAT UUID. "00000000-000

charac 0-1111-2222-0
ters. 00000000008"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 0 to - SNAT name. "snat"

255
charac
ters.

d-at 128 2:30:30"
charac
ters.

iMaster NCE-Fabric


d-at 128 2:30:30"
charac
ters.
cloud- Yes string 0 to - Cloud platform "openstack"

name 255 name
charac
ters.

-id 128 0-1111-2222-0
charac 00000000008"
ters.
snat- No string - - SNAT IP "192.168.0.1"

ipaddress.
addres
s
snat- Yes string 36 - External "00000000-000

networ charac network ID of 0-1111-2222-0
k-id ters. SNAT. 00000000008"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

router- Yes string 36 - ID of the "00000000-000

id charac router 0-1111-2222-0
ters. corresponding 00000000008"
The to SNAT.
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
orignal Yes array< - - Source CIDR ["10.10.0.0/8"]

-cidrs string> set.
type No integer - - SNAT type. The 0

value 0
indicates
NAT44, and
the value 1
indicates
NAT64.
snat- No ARRAY For details, see - -

ip-pool _REFER Table 1-565.
ENCE

iMaster NCE-Fabric
Table 1-565 snatIpPoolDto parameters

begin- Yes string - - Begin IP "192.168.0.1"

ip address.
end-ip Yes string - - End IP address. "192.168.0.255

"
Sample Request
HTTP
POST /restconf/data/huawei-ac-neutron:neutron-cfg/snats HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"snat" : [
{
"uuid" : "00000000-0000-1111-2222-000000000008",
"name" : "snat",
"updated-at" : "2017-06-24T12:30:30",
"created-at" : "2017-06-24T12:30:30",
"cloud-name" : "openstack",
"tenant-id" : "00000000-0000-1111-2222-000000000008",
"snat-ip-address" : "192.168.0.1",
"snat-network-id" : "00000000-0000-1111-2222-000000000008",
"router-id" : "00000000-0000-1111-2222-000000000008",
"orignal-cidrs" : ["10.10.0.0/8"],
"type" : 0,
"snat-ip-pool" : [
{
"begin-ip" : "192.168.0.1",
"end-ip" : "192.168.0.255"
}
]
}
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.6.2 Query the SNAT List
Typical Scenarios
SNAT needs to be queried.
Functions
Query all SNATs.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/snats
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/snats HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-566 snats parameters

eter t Value
snat ARRAY For details, see Table snat -

_REFER 1-567.
ENCE
Table 1-567 snat-wrapper parameters

eter t Value
uuid string 36 characters. - SNAT UUID. "00000000-000

The value must 0-1111-2222-0
meet the 00000000008"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 0 to 255 - SNAT name. "snat"

characters.

d-at characters. 2:30:30"

cloud- string 0 to 255 - Cloud platform "openstack"

name characters. name

iMaster NCE-Fabric

eter t Value

-id characters. 0-1111-2222-0
00000000008"
snat- string - - SNAT IP "192.168.0.1"

ipaddress.
addres
s
snat- string 36 characters. - External "00000000-000

networ The value must network ID of 0-1111-2222-0
k-id meet the SNAT. 00000000008"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
router- string 36 characters. - ID of the "00000000-000

id The value must router 0-1111-2222-0
meet the corresponding 00000000008"
following to SNAT.
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
orignal array< - - Source CIDR ["10.10.0.0/8"]

-cidrs string> set.
type integer - - SNAT type. The 0

value 0
indicates
NAT44, and
the value 1
indicates
NAT64.
snat- ARRAY For details, see Table - -

ip-pool _REFER 1-568.
ENCE

iMaster NCE-Fabric
Table 1-568 snatIpPoolDto parameters

eter t Value
begin- string - - Begin IP "192.168.0.1"

ip address.
end-ip string - - End IP address. "192.168.0.255

"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"snat" : [
{
"uuid" : "00000000-0000-1111-2222-000000000008",
"name" : "snat",
"updated-at" : "2017-06-24T12:30:30",
"created-at" : "2017-06-24T12:30:30",
"tenant-id" : "00000000-0000-1111-2222-000000000008",
"snat-ip-address" : "192.168.0.1",
"snat-network-id" : "00000000-0000-1111-2222-000000000008",
"router-id" : "00000000-0000-1111-2222-000000000008",
"orignal-cidrs" : ["10.10.0.0/8"],
"type" : 0,
"snat-ip-pool" : [
{
"begin-ip" : "192.168.0.1",
"end-ip" : "192.168.0.255"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.6.3 Query SNAT by Name
Typical Scenarios
The SNAT needs to be queried by name.
Functions
Query SNAT by name.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/snats/snat/{id}

id Yes string 1 to - SNAT ID. "00000000-000

128 0-1111-2222-0
charac 00000000008"
ters.
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /restconf/data/huawei-ac-neutron:neutron-cfg/snats/snat/00000000-0000-1111-2222-000000000008
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
snats parameters, For details, see Table 1-566.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"snat" : [
{
"uuid" : "00000000-0000-1111-2222-000000000008",
"name" : "snat",
"updated-at" : "2017-06-24T12:30:30",
"created-at" : "2017-06-24T12:30:30",
"tenant-id" : "00000000-0000-1111-2222-000000000008",
"snat-ip-address" : "192.168.0.1",
"snat-network-id" : "00000000-0000-1111-2222-000000000008",
"router-id" : "00000000-0000-1111-2222-000000000008",
"orignal-cidrs" : ["10.10.0.0/8"],
"type" : 0,
"snat-ip-pool" : [
{
"begin-ip" : "192.168.0.1",
"end-ip" : "192.168.0.255"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.6.4 Update the SNAT by Name
Typical Scenarios
The SNAT needs to be updated.
Functions
Update SNAT.
Constraints
HTTP Method
PUT
URI


128 0-1111-2222-0
charac 00000000008"
ters.

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table SNAT -

be
updated.
Sample Request
HTTP
PUT /restconf/data/huawei-ac-neutron:neutron-cfg/snats/snat/00000000-0000-1111-2222-000000000008
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"snat" : [
{
"uuid" : "00000000-0000-1111-2222-000000000008",
"name" : "snat",
"updated-at" : "2017-06-24T12:30:30",
"created-at" : "2017-06-24T12:30:30",
"tenant-id" : "00000000-0000-1111-2222-000000000008",
"snat-ip-address" : "192.168.0.1",
"snat-network-id" : "00000000-0000-1111-2222-000000000008",
"router-id" : "00000000-0000-1111-2222-000000000008",
"orignal-cidrs" : ["10.10.0.0/8"],
"type" : 0,
"snat-ip-pool" : [
{
"begin-ip" : "192.168.0.1",
"end-ip" : "192.168.0.255"
}
]
}
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.6.5 Delete SNAT by Name
Typical Scenarios
The SNAT needs to be deleted.
Functions
Delete an SNAT by name.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric


128 0-1111-2222-0
charac 00000000008"
ters.
Request Parameters
N/A
Sample Request
HTTP
DELETE /restconf/data/huawei-ac-neutron:neutron-cfg/snats/snat/
00000000-0000-1111-2222-000000000008 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.7 Floating IP Address
1.9.5.7.1 Create a Floating IP Address
Typical Scenarios
A floating IP address needs to be created.
Functions
Create a floating IP address.
Constraints
HTTP Method
POST
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/floatingips
Request Parameters

cloud Yes REFER For details, see Floating IP -

ENCE Table 1-574. address entity
to be created.

iMaster NCE-Fabric
Table 1-574 floatingips parameters

floatin No ARRAY For details, see Floating IP -

gip _REFER Table 1-575. address entity.
ENCE
Table 1-575 l3-floatingip-wrapper parameters

uuid Yes string 36 - Floating IP "00000004-000

charac address ID. 0-3333-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 0 to - Floating IP "FloatingIpNa

255 address ID. me"
charac
ters.

d-at 128 8:15:49"
charac
ters.

iMaster NCE-Fabric


d-at 128 8:15:49"
charac
ters.

name 255 name.
charac
ters.

-id 128 0-3333-0000-0
charac 00000000001"
ters.
floatin Yes string 36 - Network ID. "00000004-000

g- charac 0-3333-0000-0
networ ters. 00000000001"
k-id The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

port-id Yes string 36 - Port ID. "00000004-000

charac 0-3333-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
fixed- Yes string - - Fixed IP "192.168.2.2"

ipaddress.
addres
s
floatin Yes string - - Floating IP "192.168.3.3"

g-ipaddress.
addres
s

iMaster NCE-Fabric

router- No string 36 - Router ID. "00000004-000

id charac 0-3333-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Sample Request
HTTP
POST /restconf/data/huawei-ac-neutron:neutron-cfg/floatingips HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"floatingip" : [
{
"uuid" : "00000004-0000-3333-0000-000000000001",
"name" : "FloatingIpName",
"updated-at" : "2018-02-20T08:15:49",
"created-at" : "2018-02-20T08:15:49",
"tenant-id" : "00000004-0000-3333-0000-000000000001",
"floating-network-id" : "00000004-0000-3333-0000-000000000001",
"port-id" : "00000004-0000-3333-0000-000000000001",
"fixed-ip-address" : "192.168.2.2",
"floating-ip-address" : "192.168.3.3",
"router-id" : "00000004-0000-3333-0000-000000000001"

iMaster NCE-Fabric
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.7.2 Query the Floating IP Address List
Typical Scenarios
A floating IP address needs to be queried.
Functions
Query all floating IP addresses.
Constraints

iMaster NCE-Fabric

HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/floatingips
Request Parameters
N/A
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/floatingips HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-576 floatingips parameters

eter t Value
floatin ARRAY For details, see Table Floating IP -

gip _REFER 1-577. address entity.
ENCE

iMaster NCE-Fabric
Table 1-577 l3-floatingip-wrapper parameters

eter t Value
uuid string 36 characters. - Floating IP "00000004-000

The value must address ID. 0-3333-0000-0
meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 0 to 255 - Floating IP "FloatingIpNa

characters. address ID. me"



name characters. name.

00000000001"
floatin string 36 characters. - Network ID. "00000004-000

g- The value must 0-3333-0000-0
networ meet the 00000000001"
k-id following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
port-id string 36 characters. - Port ID. "00000004-000

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
fixed- string - - Fixed IP "192.168.2.2"

ipaddress.
addres
s
floatin string - - Floating IP "192.168.3.3"

g-ipaddress.
addres
s
router- string 36 characters. - Router ID. "00000004-000

id The value must 0-3333-0000-0
meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"floatingip" : [
{
"uuid" : "00000004-0000-3333-0000-000000000001",
"updated-at" : "2018-02-20T08:15:49",
"created-at" : "2018-02-20T08:15:49",
"tenant-id" : "00000004-0000-3333-0000-000000000001",
"port-id" : "00000004-0000-3333-0000-000000000001",
"router-id" : "00000004-0000-3333-0000-000000000001"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.7.3 Query a Floating IP Address by Name
Typical Scenarios
A floating IP address needs to be queried by name.
Functions
Query floating IP addresses by name.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/floatingips/floatingip/{urlId}

urlId Yes string 1 to - Floating IP -

128 address ID.
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/floatingips/floatingip/{urlId} HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
floatingips parameters, For details, see Table 1-576.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"floatingip" : [
{

iMaster NCE-Fabric
"uuid" : "00000004-0000-3333-0000-000000000001",
"updated-at" : "2018-02-20T08:15:49",
"created-at" : "2018-02-20T08:15:49",
"tenant-id" : "00000004-0000-3333-0000-000000000001",
"port-id" : "00000004-0000-3333-0000-000000000001",
"router-id" : "00000004-0000-3333-0000-000000000001"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.7.4 Update a Floating IP Address Based on the Name
Typical Scenarios
A floating IP address needs to be updated.
Functions
Update the floating IP address.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

urlId Yes string 1 to - Floating IP "00000004-000

128 address ID. 0-3333-0000-0
charac 00000000001"
ters.
Request Parameters

cloud Yes REFER For details, see Floating IP -

ENCE Table 1-574. address entity
to be updated.
Sample Request
HTTP
PUT /restconf/data/huawei-ac-neutron:neutron-cfg/floatingips/floatingip/
00000004-0000-3333-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"floatingip" : [
{
"uuid" : "00000004-0000-3333-0000-000000000001",
"updated-at" : "2018-02-20T08:15:49",
"created-at" : "2018-02-20T08:15:49",
"tenant-id" : "00000004-0000-3333-0000-000000000001",
"port-id" : "00000004-0000-3333-0000-000000000001",
"router-id" : "00000004-0000-3333-0000-000000000001"
}
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.7.5 Delete a Floating IP Address by Name
Typical Scenarios
A floating IP address needs to be deleted.
Functions
Delete a floating IP address by name.
Constraints
HTTP Method
DELETE

iMaster NCE-Fabric
URI

urlId Yes string 1 to - Floating IP "00000004-000

128 address ID. 0-3333-0000-0
charac 00000000001"
ters.
Request Parameters
N/A
Sample Request
HTTP
DELETE /restconf/data/huawei-ac-neutron:neutron-cfg/floatingips/floatingip/
00000004-0000-3333-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.8 Qos
1.9.5.8.1 Create a QoS Policy
Typical Scenarios
A QoS policy needs to be created.
Functions
Create a QoS policy.
Constraints
HTTP Method
POST
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/qos-policies
Request Parameters

er Range Value on
input REFERE For details, see Table QoS -

be
created.

iMaster NCE-Fabric
Table 1-583 qos-policies parameters

qos- No ARRAY For details, see qos-policy -

policy _REFER Table 1-584.
ENCE
Table 1-584 qos-policy parameters

uuid Yes string 36 - QoS policy ID. "8938f538-200

charac 6-4dde-8902-6
ters. d3f676d3790"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 0 to - QoS policy "qosName"

255 name.
charac
ters.

iMaster NCE-Fabric


d-at 128 5:30:31"
charac
ters.

d-at 128 5:30:31"
charac
ters.

name 255 name.
charac
ters.
tenant Yes string 0 to - Tenant ID. "8938f538-200

-id 128 6-4dde-8902-6
charac d3f676d3790"
ters.
qos- No REFER For details, see - -

bandw ENCE Table 1-585.
idth-
limit-
rules

dscp- ENCE Table 1-587.
limit-
rules

cos- ENCE Table 1-589.
markin
g-rules
Table 1-585 qos-bandwidth-limit-rules parameters

qos- No ARRAY For details, see qos- -

bandw _REFER Table 1-586. bandwidth-
idth- ENCE limit-rule
limit-
rule

iMaster NCE-Fabric
Table 1-586 qos-bandwidth-limit-rule-attributes parameters

directi No string ● inb - Direction. The "inbound"

on oun value can be
d inbound or
● out outbound.
bou
nd
max- No int64 - - - 10000

kbps
uuid Yes string 36 - ID of a "8938f538-200

charac bandwidth 6-4dde-8902-6
ters. limit rule. d3f676d3790"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
max- No int64 - - - 20000

burst-
kbps

iMaster NCE-Fabric

qos- Yes string 36 - QoS policy ID. "8938f538-200

policy- charac 6-4dde-8902-6
id ters. d3f676d3790"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Table 1-587 qos-dscp-limit-rules parameters

qos- No ARRAY For details, see DSCP rule set. -

dscp- _REFER Table 1-588.
limit- ENCE
rule

iMaster NCE-Fabric
Table 1-588 qos-dscp-limit-rule-attributes parameters

uuid Yes string 36 - DSCP rule ID. "8938f538-200

charac 6-4dde-8902-6
ters. d3f676d3790"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
dscp- Yes int64 - - The value can 8

mark be 0, an even
number
between 8 and
56 except 42,
44, 50, 52, and
54.
Table 1-589 qos-cos-marking-rules parameters

qos- No ARRAY For details, see CoS marking -

cos- _REFER Table 1-590. rule set.
markin ENCE
g-rule

iMaster NCE-Fabric
Table 1-590 qos-cos-marking-rule-attributes parameters

uuid Yes string 36 - VLAN priority "8938f538-200

charac rule ID. 6-4dde-8902-6
ters. d3f676d3790"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
cos- Yes int64 - - 0 or 7. 0

mark
Sample Request
HTTP
POST /restconf/data/huawei-ac-neutron:neutron-cfg/qos-policies HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"qos-policy" : [
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"name" : "qosName",
"updated-at" : "2017-01-13T05:30:31",
"created-at" : "2017-01-13T05:30:31",

iMaster NCE-Fabric
"tenant-id" : "8938f538-2006-4dde-8902-6d3f676d3790",
"qos-bandwidth-limit-rules" : {
"qos-bandwidth-limit-rule" : [
{
"direction" : "inbound",
"max-kbps" : 10000,
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"max-burst-kbps" : 20000,
"qos-policy-id" : "8938f538-2006-4dde-8902-6d3f676d3790"
}
]
},
"qos-dscp-limit-rules" : {
"qos-dscp-limit-rule" : [
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"dscp-mark" : 8
}
]
},
"qos-cos-marking-rules" : {
"qos-cos-marking-rule" : [
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"cos-mark" : 0
}
]
}
}
]
}
Response Parameters
Response status code 201: QoS entity to be created.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.8.2 Query the QoS List
Typical Scenarios
QoS information needs to be queried.
Functions
Query all QoSs.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/qos-policies
Request Parameters
N/A
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/qos-policies HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-591 qos-policies parameters

eter t Value
qos- ARRAY For details, see Table qos-policy -

policy _REFER 1-592.
ENCE
Table 1-592 qos-policy parameters

eter t Value
uuid string 36 characters. - QoS policy ID. "8938f538-200

The value must 6-4dde-8902-6
meet the d3f676d3790"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 0 to 255 - QoS policy "qosName"

characters. name.



tenant string 0 to 128 - Tenant ID. "8938f538-200

-id characters. 6-4dde-8902-6
d3f676d3790"
qos- REFER For details, see Table - -

bandw ENCE 1-593.
idth-
limit-
rules

dscp- ENCE 1-595.
limit-
rules

iMaster NCE-Fabric

eter t Value

cos- ENCE 1-597.
markin
g-rules
Table 1-593 qos-bandwidth-limit-rules parameters

eter t Value
qos- ARRAY For details, see Table qos- -

bandw _REFER 1-594. bandwidth-
idth- ENCE limit-rule
limit-
rule
Table 1-594 qos-bandwidth-limit-rule-attributes parameters

eter t Value
directi string ● inbound - Direction. The "inbound"

on value can be
● outbound
inbound or
outbound.
max- int64 - - - 10000

kbps
uuid string 36 characters. - ID of a "8938f538-200

The value must bandwidth 6-4dde-8902-6
meet the limit rule. d3f676d3790"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
max- int64 - - - 20000

burst-
kbps

iMaster NCE-Fabric

eter t Value
qos- string 36 characters. - QoS policy ID. "8938f538-200

policy- The value must 6-4dde-8902-6
id meet the d3f676d3790"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Table 1-595 qos-dscp-limit-rules parameters

eter t Value
qos- ARRAY For details, see Table DSCP rule set. -

dscp- _REFER 1-596.
limit- ENCE
rule
Table 1-596 qos-dscp-limit-rule-attributes parameters

eter t Value
uuid string 36 characters. - DSCP rule ID. "8938f538-200

The value must 6-4dde-8902-6
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
dscp- int64 - - The value can 8

mark be 0, an even
number
between 8 and
56 except 42,
44, 50, 52, and
54.
Table 1-597 qos-cos-marking-rules parameters

eter t Value
qos- ARRAY For details, see Table CoS marking -

cos- _REFER 1-598. rule set.
markin ENCE
g-rule
Table 1-598 qos-cos-marking-rule-attributes parameters

eter t Value
uuid string 36 characters. - VLAN priority "8938f538-200

The value must rule ID. 6-4dde-8902-6
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
cos- int64 - - 0 or 7. 0
mark

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"qos-policy" : [
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"name" : "qosName",
"updated-at" : "2017-01-13T05:30:31",
"created-at" : "2017-01-13T05:30:31",
{
"max-kbps" : 10000,
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
}
]
},
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"dscp-mark" : 8
}
]
},
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"cos-mark" : 0
}
]
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.8.3 Query QoS by Name
Typical Scenarios
The QoS needs to be queried by name.
Functions
Query QoS by name.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/qos-policies/qos-policy/{id}

id Yes string 1 to - QoS ID. "8938f538-200

128 6-4dde-8902-6
charac d3f676d3790"
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/qos-policies/qos-policy/
8938f538-2006-4dde-8902-6d3f676d3790 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Response status code 200: Succeeded.
qos-policies parameters, For details, see Table 1-591.
Response status code 400: The parameter format is incorrect. For example, the
parameter type is incorrect or the value range is incorrect.
Response status code 500: The internal processing mechanism is defective.
Sample Response
Response status code 200: Succeeded.
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"qos-policy" : [
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"name" : "qosName",
"updated-at" : "2017-01-13T05:30:31",
"created-at" : "2017-01-13T05:30:31",
{
"max-kbps" : 10000,
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
}
]
},
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"dscp-mark" : 8
}
]
},
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"cos-mark" : 0
}
]
}
}
]
}
Response status code 400: The parameter format is incorrect. For example, the
parameter type is incorrect or the value range is incorrect.

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Response status code 500: The internal processing mechanism is defective.

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.8.4 Update QoS by Name
Typical Scenarios
The QoS needs to be updated.
Functions
Update the QoS.
Constraints
HTTP Method
PUT
URI


128 6-4dde-8902-6
charac d3f676d3790"
ters.

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table QoS -

be
updated.
Sample Request
HTTP
PUT /restconf/data/huawei-ac-neutron:neutron-cfg/qos-policies/qos-policy/
8938f538-2006-4dde-8902-6d3f676d3790 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"qos-policy" : [
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"name" : "qosName",
"updated-at" : "2017-01-13T05:30:31",
"created-at" : "2017-01-13T05:30:31",
{
"max-kbps" : 10000,
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
}
]
},
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"dscp-mark" : 8
}
]
},
{
"uuid" : "8938f538-2006-4dde-8902-6d3f676d3790",
"cos-mark" : 0
}
]
}
}
]
}

iMaster NCE-Fabric
Response Parameters
Response status code 204: Update QoS by Name
Sample Response
Response status code 204: Update QoS by Name
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.8.5 Delete a QoS Policy by Name
Typical Scenarios
A QoS needs to be deleted.
Functions
Delete a QoS policy by name.
Constraints

iMaster NCE-Fabric
HTTP Method
DELETE
URI


128 6-4dde-8902-6
charac d3f676d3790"
ters.
Request Parameters
N/A
Sample Request
HTTP
DELETE /restconf/data/huawei-ac-neutron:neutron-cfg/qos-policies/qos-policy/
8938f538-2006-4dde-8902-6d3f676d3790 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.9 Security Group
1.9.5.9.1 Create a Security Group
Typical Scenarios
A security rule needs to be created.
Functions
Create a security group.
Constraints
HTTP Method
POST
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/security-groups

iMaster NCE-Fabric
Request Parameters

cloud Yes REFER For details, see Security group -

ENCE Table 1-604. entity to be
created.
Table 1-604 security-groups parameters

securit No ARRAY For details, see List of -

y- _REFER Table 1-605. Metering
group ENCE Labels.

iMaster NCE-Fabric
Table 1-605 security-group parameters

uuid Yes string 36 - Security group "00000000-000

charac ID 0-1111-2222-0
ters. 00000000008"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 0 to - Security group "name"

255 name.
charac
ters.

d-at 128 2:30:30"
charac
ters.

d-at 128 2:30:30"
charac
ters.

name 255 name
charac
ters.

iMaster NCE-Fabric


-id 128 0-1111-2222-0
charac 00000000008"
ters.
descrip No string 0 to - Security group "this is a discr"

charac
ters.
securit No array< - - Security group ["00000000-00

y-rules string> rule list. 00-1111-2220-
000000000008
"]
Sample Request
HTTP
POST /restconf/data/huawei-ac-neutron:neutron-cfg/security-groups HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"security-group" : [
{
"uuid" : "00000000-0000-1111-2222-000000000008",
"name" : "name",
"updated-at" : "2017-06-24T12:30:30",
"created-at" : "2017-06-24T12:30:30",
"tenant-id" : "00000000-0000-1111-2222-000000000008",
"description" : "this is a discr",
"security-rules" : ["00000000-0000-1111-2220-000000000008"]
}
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.9.2 Query Security Groups
Typical Scenarios
A security group needs to be queried.
Functions
Query all security groups.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/security-groups
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/security-groups HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-606 security-groups parameters

eter t Value
securit ARRAY For details, see Table List of -

y- _REFER 1-607. Metering
group ENCE Labels.
Table 1-607 security-group parameters

eter t Value
uuid string 36 characters. - Security group "00000000-000

The value must ID 0-1111-2222-0
meet the 00000000008"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 0 to 255 - Security group "name"

characters. name.



iMaster NCE-Fabric

eter t Value

name characters. name

00000000008"
descrip string 0 to 256 - Security group "this is a discr"

securit array< - - Security group ["00000000-00

y-rules string> rule list. 00-1111-2220-
000000000008
"]
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
{
"uuid" : "00000000-0000-1111-2222-000000000008",
"name" : "name",
"updated-at" : "2017-06-24T12:30:30",
"created-at" : "2017-06-24T12:30:30",
"tenant-id" : "00000000-0000-1111-2222-000000000008",
"security-rules" : ["00000000-0000-1111-2220-000000000008"]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.9.3 Query a Security Group by Name
Typical Scenarios
A security group needs to be queried by name.
Functions
Query a security group by name.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/security-groups/security-group/{id}

id Yes string 1 to - Security group "00000000-000

128 ID. 0-1111-2222-0
charac 00000000008"
ters.
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /restconf/data/huawei-ac-neutron:neutron-cfg/security-groups/security-group/
00000000-0000-1111-2222-000000000008 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
security-groups parameters, For details, see Table 1-606.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
{
"uuid" : "00000000-0000-1111-2222-000000000008",
"name" : "name",
"updated-at" : "2017-06-24T12:30:30",
"created-at" : "2017-06-24T12:30:30",
"tenant-id" : "00000000-0000-1111-2222-000000000008",
"security-rules" : ["00000000-0000-1111-2220-000000000008"]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.9.4 Update a Security Group by Name
Typical Scenarios
A security group needs to be updated.
Functions
Update a security group.
Constraints
HTTP Method
PUT
URI


128 ID. 0-1111-2222-0
charac 00000000008"
ters.
Request Parameters

cloud Yes REFER For details, see Security group -

ENCE Table 1-604. entity to be
updated.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /restconf/data/huawei-ac-neutron:neutron-cfg/security-groups/security-group/
00000000-0000-1111-2222-000000000008 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
{
"uuid" : "00000000-0000-1111-2222-000000000008",
"name" : "name",
"updated-at" : "2017-06-24T12:30:30",
"created-at" : "2017-06-24T12:30:30",
"tenant-id" : "00000000-0000-1111-2222-000000000008",
"security-rules" : ["00000000-0000-1111-2220-000000000008"]
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.9.5 Deleting a Security Group by Name
Typical Scenarios
A security group needs to be deleted.
Functions
Delete a security group by name.
Constraints
HTTP Method
DELETE
URI


128 ID. 0-1111-2222-0
charac 00000000008"
ters.
Request Parameters
N/A
Sample Request
HTTP
DELETE /restconf/data/huawei-ac-neutron:neutron-cfg/security-groups/security-group/
00000000-0000-1111-2222-000000000008 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.10 Security Group Rules
1.9.5.10.1 Create a Security Rule
Typical Scenarios
Functions
Create a security rule.

iMaster NCE-Fabric
Constraints
HTTP Method
POST
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/security-rules
Request Parameters

cloud Yes REFER For details, see Security rule -

ENCE Table 1-613. entity.
Table 1-613 security-rules parameters

securit No ARRAY For details, see Security group -

y-rule _REFER Table 1-614. rule list.
ENCE
Table 1-614 security-rule-attributes parameters

remote No string - - Peer IP prefix. "10.10.10.0/8"

-ip-
prefix
directi Yes string 0 to - Security group "this is a discr"

on 128 rule
charac description.
ters.

iMaster NCE-Fabric

protoc No string 0 to 8 - Security group "5"

ol charac rule protocol.
ters.
etherty No string 0 to - IP address "huawei-ac-

pe 128 version neutron-
charac corresponding constants:ether
ters. to the security type-v4"
group rule.

d-at 128 5:30:31"
charac
ters.

d-at 128 5:30:31"
charac
ters.
port- No int32 - - Maximum 100

range- value of the
max port range.

iMaster NCE-Fabric

securit Yes string 36 - ID of the "11000000-200

y- charac security group. 0-0000-0000-0
group- ters. 00000000020"
id The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
port- No int32 - - Minimum 10

range- value of the
min port range.

iMaster NCE-Fabric

remote No string 36 - Remote "11000000-200

- charac security group 0-0000-0000-0
group- ters. ID. 00000000020"
id The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

id Yes string 36 - Security group "11000000-200

charac ID. 0-0000-0000-0
ters. 00000000020"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
tenant Yes string 0 to - UUID of the "11000000-200

-id 128 tenant. 0-0000-0000-0
charac 00000000020"
ters.
Sample Request
HTTP
POST /restconf/data/huawei-ac-neutron:neutron-cfg/security-rules HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"security-rule" : [
{
"remote-ip-prefix" : "10.10.10.0/8",
"direction" : "this is a discr",
"protocol" : "5",
"ethertype" : "huawei-ac-neutron-constants:ethertype-v4",

iMaster NCE-Fabric
"updated-at" : "2017-01-13T05:30:31",
"created-at" : "2017-01-13T05:30:31",
"port-range-max" : 100,
"security-group-id" : "11000000-2000-0000-0000-000000000020",
"port-range-min" : 10,
"remote-group-id" : "11000000-2000-0000-0000-000000000020",
"id" : "11000000-2000-0000-0000-000000000020",
"tenant-id" : "11000000-2000-0000-0000-000000000020"
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.10.2 Query Security Rules
Typical Scenarios
Security rules need to be queried.

iMaster NCE-Fabric
Functions
Query all security rules.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/security-rules
Request Parameters
N/A
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/security-rules HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-615 security-rules parameters

eter t Value
securit ARRAY For details, see Table Security group -

y-rule _REFER 1-616. rule list.
ENCE

iMaster NCE-Fabric
Table 1-616 security-rule-attributes parameters

eter t Value
remote string - - Peer IP prefix. "10.10.10.0/8"

-ip-
prefix
directi string 0 to 128 - Security group "this is a discr"

on characters. rule
description.
protoc string 0 to 8 - Security group "5"

ol characters. rule protocol.
etherty string 0 to 128 - IP address "huawei-ac-

pe characters. version neutron-
corresponding constants:ether
to the security type-v4"
group rule.


port- int32 - - Maximum 100

range- value of the
max port range.
securit string 36 characters. - ID of the "11000000-200

y- The value must security group. 0-0000-0000-0
group- meet the 00000000020"
id following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
port- int32 - - Minimum 10

range- value of the
min port range.

iMaster NCE-Fabric

eter t Value
remote string 36 characters. - Remote "11000000-200

- The value must security group 0-0000-0000-0
group- meet the ID. 00000000020"
id following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
id string 36 characters. - Security group "11000000-200

meet the 00000000020"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
tenant string 0 to 128 - UUID of the "11000000-200

-id characters. tenant. 0-0000-0000-0
00000000020"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"security-rule" : [
{

iMaster NCE-Fabric
"remote-ip-prefix" : "10.10.10.0/8",
"protocol" : "5",
"updated-at" : "2017-01-13T05:30:31",
"created-at" : "2017-01-13T05:30:31",
"remote-group-id" : "11000000-2000-0000-0000-000000000020",
"id" : "11000000-2000-0000-0000-000000000020",
"tenant-id" : "11000000-2000-0000-0000-000000000020"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.10.3 Query a Security Rule by Name
Typical Scenarios
A security rule needs to be queried by name.
Functions
Query a security rule by name.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/security-rules/security-rule/{id}

iMaster NCE-Fabric

id Yes string 1 to - Security rule -

128 ID.
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/security-rules/security-rule/{id} HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
security-rules parameters, For details, see Table 1-615.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"security-rule" : [
{
"remote-ip-prefix" : "10.10.10.0/8",
"protocol" : "5",
"updated-at" : "2017-01-13T05:30:31",

iMaster NCE-Fabric
"created-at" : "2017-01-13T05:30:31",
"remote-group-id" : "11000000-2000-0000-0000-000000000020",
"id" : "11000000-2000-0000-0000-000000000020",
"tenant-id" : "11000000-2000-0000-0000-000000000020"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.10.4 Delete a Security Rule by Name
Typical Scenarios
Functions
Delete a security rule by name.
Constraints
HTTP Method
DELETE
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/security-rules/security-rule/{id}

iMaster NCE-Fabric

id Yes string 1 to - Security rule -

128 ID.
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
DELETE /restconf/data/huawei-ac-neutron:neutron-cfg/security-rules/security-rule/{id} HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.11 Firewall
# Firewall operation APIs
1.9.5.11.1 Create a Firewall Rule
Typical Scenarios
A firewall needs to be created.
Functions
Create a firewall.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/fw/firewalls
Request Parameters

firewal Yes REFER For details, see Parameters for -

lDtoWr ENCE Table 1-620. creating a
apper firewall.

iMaster NCE-Fabric
Table 1-620 FirewallDtoWrapper parameters


_name 255 name.
charac
ters.
firewal Yes REFER For details, see Firewall object. -

l ENCE Table 1-621.
Table 1-621 FirewallDto parameters


0001"
id Yes string 36 - UUID of a "ff000000-

charac firewall. This ff00-0000-
ters. field cannot be abce-00000000
The updated. 0001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

descrip No string 0 to - Firewall "firewall

tion 1024 description. description"
charac
ters.
name No string 0 to - Firewall name. "test_fw1"

255
charac
ters.
status No string 0 to - Router status. "ACTIVE"

255
charac
ters.

_state_ 255 status.
up charac
ters.
shared No string 0 to - Whether a "false"

255 firewall policy
charac can be shared.
ters.
firewal Yes string 0 to 36 - UUID of a "9951b5fd-

l_polic charac firewall policy. d187-4ab6-
y_id ters. b71f-397dd193
2027"
router_ No array< 0-255 - UUID list of ["00000000-00

ids string> items. routers 00-0000-1234-
Each associated with 000000000003
item firewalls. The "]
has 0 firewalls will
to 36 be applied to
charac the associated
ters. routers.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/fw/firewalls HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{

iMaster NCE-Fabric
"firewall" : {
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-ff00-0000-abce-000000000001",
"description" : "firewall description",
"name" : "test_fw1",
"shared" : "false",
"firewall_policy_id" : "9951b5fd-d187-4ab6-b71f-397dd1932027",
"router_ids" : ["00000000-0000-0000-1234-000000000003"]
}
}
Response Parameters
Table 1-622 FirewallDtoWrapper parameters

eter t Value

firewal REFER For details, see Table Firewall object. -

l ENCE 1-623.
Table 1-623 FirewallDto parameters

eter t Value

0001"
id string 36 characters. - UUID of a "ff000000-

The value must firewall. This ff00-0000-
meet the field cannot be abce-00000000
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
descrip string 0 to 1024 - Firewall "firewall

tion characters. description. description"

iMaster NCE-Fabric

eter t Value
name string 0 to 255 - Firewall name. "test_fw1"

characters.
status string 0 to 255 - Router status. "ACTIVE"

characters.

up
shared string 0 to 255 - Whether a "false"

characters. firewall policy
can be shared.
firewal string 0 to 36 - UUID of a "9951b5fd-

l_polic characters. firewall policy. d187-4ab6-
y_id b71f-397dd193
2027"
router_ array< 0-255 items. - UUID list of ["00000000-00

ids string> Each item has 0 routers 00-0000-1234-
to 36 associated with 000000000003
characters. firewalls. The "]
firewalls will
be applied to
the associated
routers.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewall" : {
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-ff00-0000-abce-000000000001",

iMaster NCE-Fabric
"shared" : "false",
"router_ids" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.11.2 Query All Firewalls
Typical Scenarios
All firewalls need to be queried.
Functions
Query all firewalls.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/fw/firewalls

iMaster NCE-Fabric


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/fw/firewalls?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-625 FirewallQueryOutputDto parameters

eter t Value
firewal ARRAY 0-255 items. For details, Firewall list. -

ls _REFER see Table 1-623.
ENCE


iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewalls" : [
{
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-ff00-0000-abce-000000000001",
"shared" : "false",
"router_ids" : ["00000000-0000-0000-1234-000000000003"]
}
],
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.11.3 Query a Firewall Rule by ID
Typical Scenarios
A firewall needs to be queried by ID.
Functions
Query a firewall by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/fw/firewalls/{id}

id Yes string 36 - ID for querying "ff000000-

charac a firewall. ff00-0000-
ters. abce-00000000
The 0001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/fw/firewalls/ff000000-ff00-0000-abce-000000000001 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
FirewallDtoWrapper parameters, For details, see Table 1-622.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewall" : {
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-ff00-0000-abce-000000000001",
"shared" : "false",
"router_ids" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.11.4 Update a Firewall Rule by ID
Typical Scenarios
A firewall needs to be updated by ID.
Functions
Update a firewall by ID.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes string 36 - ID for updating "ff000000-

ters. abce-00000000
The 0001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

firewal Yes REFER For details, see Firewall entity. -

lDtoWr ENCE Table 1-620.
apper
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/fw/firewalls/ff000000-ff00-0000-abce-000000000001 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"firewall" : {
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-ff00-0000-abce-000000000001",
"shared" : "false",
"router_ids" : ["00000000-0000-0000-1234-000000000003"]
}
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewall" : {
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-ff00-0000-abce-000000000001",
"shared" : "false",
"router_ids" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.11.5 Delete a Firewall Rule by ID
Typical Scenarios
A firewall needs to be deleted by ID.
Functions
Delete a firewall by ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric

id Yes string 36 - ID for deleting "ff000000-

ters. abce-00000000
The 0001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/fw/firewalls/ff000000-ff00-0000-abce-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric

Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewall" : {
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-ff00-0000-abce-000000000001",
"shared" : "false",
"router_ids" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.12 Firewall Policies

# Firewall policy operation APIs

iMaster NCE-Fabric
1.9.5.12.1 Create a Firewall Policy
Typical Scenarios
A firewall policy needs to be created. This operation can be performed only after
firewall rules are created.
Functions
Create a firewall policy.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/fw/firewall_policies
Request Parameters


lPolicy ENCE Table 1-631. creating a
DtoWr firewall policy.
apper
Table 1-631 FirewallPolicyDtoWrapper parameters


_name 255 name.
charac
ters.
firewal Yes REFER For details, see - -

lPolicy ENCE Table 1-632.

iMaster NCE-Fabric
Table 1-632 FirewallPolicyDto parameters

tenant Yes string - - Tenant ID. This "00000000-000

_id field cannot be 0-0000-
0001"
id Yes uuid - - UUID of a "ff000000-0000

firewall policy. -0002-
This field abce-00000000
cannot be 0001"
updated.
descrip No string 0 to - Firewall policy "a firewall rule

charac
ters.
name No string 0 to - Firewall policy "a firewall

255 name. rule"
charac
ters.
firewal No array< 0-255 - UUID list of ["00000000-00

l_rules string> items. firewall rules. 00-0000-
Each abce-00000000
item 0002","000000
has 0 00-0000-0000-
to 36 abce-00000000
charac 0003"]
ters.

255 firewall policy
charac can be shared.
ters.
audite No string 0 to - Whether a "false"

d 255 firewall policy
charac is approved.
ters.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/fw/firewall_policies HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
{
"firewallPolicy" : {
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-0000-0002-abce-000000000001",
"description" : "a firewall rule description",
"name" : "a firewall rule",
"firewall_rules" : ["00000000-0000-0000-abce-000000000002","00000000-0000-0000-
abce-000000000003"],
"shared" : "false",
"audited" : "false"
}
}
Response Parameters
Table 1-633 FirewallPolicyDtoWrapper parameters

eter t Value

firewal REFER For details, see Table - -

lPolicy ENCE 1-634.
Table 1-634 FirewallPolicyDto parameters

eter t Value
tenant string - - Tenant ID. This "00000000-000

_id field cannot be 0-0000-
0001"
id uuid - - UUID of a "ff000000-0000

firewall policy. -0002-
This field abce-00000000
cannot be 0001"
updated.
descrip string 0 to 1024 - Firewall policy "a firewall rule

name string 0 to 255 - Firewall policy "a firewall

characters. name. rule"

iMaster NCE-Fabric

eter t Value
firewal array< 0-255 items. - UUID list of ["00000000-00

l_rules string> Each item has 0 firewall rules. 00-0000-
to 36 abce-00000000
characters. 0002","000000
00-0000-0000-
abce-00000000
0003"]

characters. firewall policy
can be shared.
audite string 0 to 255 - Whether a "false"

d characters. firewall policy
is approved.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-0000-0002-abce-000000000001",
abce-000000000003"],
"shared" : "false",
"audited" : "false"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.12.2 Query All Firewall Policies
Typical Scenarios
All firewall policies need to be queried.
Functions
Query all firewall policies.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/fw/firewall_policies


dex number.

ze
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/fw/firewall_policies?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-636 FirewallPolicyQueryOutputDto parameters

eter t Value
firewal ARRAY 0-255 items. For details, List of firewall -

lPolicy _REFER see Table 1-634. policy objects.
s ENCE
service string 0 to 255 - Cloud platform "physnet"

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewallPolicys" : [
{
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-0000-0002-abce-000000000001",
abce-000000000003"],
"shared" : "false",
"audited" : "false"
}

iMaster NCE-Fabric
],
"service_name" : "physnet"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.12.3 Query a Firewall Policy by ID
Typical Scenarios
A firewall policy needs to be queried by ID.
Functions
Query a firewall policy by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/fw/firewall_policies/{id}

id Yes uuid - - ID for querying "ff000000-0000

a firewall -0002-
policy. abce-00000000
0001"

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/fw/firewall_policies/ff000000-0000-0002-abce-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
FirewallPolicyDtoWrapper parameters, For details, see Table 1-633.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-0000-0002-abce-000000000001",
abce-000000000003"],
"shared" : "false",
"audited" : "false"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.12.4 Update a Firewall Policy by ID
Typical Scenarios
A firewall policy needs to be updated by ID.
Functions
Update a firewall policy by ID.
Constraints
HTTP Method
PUT
URI

id Yes uuid - - ID for updating "ff000000-0000

a firewall -0002-
0001"

iMaster NCE-Fabric
Request Parameters


lPolicy ENCE Table 1-631. updating a
DtoWr firewall policy.
apper
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/fw/firewall_policies/ff000000-0000-0002-abce-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-0000-0002-abce-000000000001",
abce-000000000003"],
"shared" : "false",
"audited" : "false"
}
}
Response Parameters
FirewallPolicyDtoWrapper parameters, For details, see Table 1-633.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"id" : "ff000000-0000-0002-abce-000000000001",
abce-000000000003"],
"shared" : "false",
"audited" : "false"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.12.5 Delete a Firewall Policy by ID
Typical Scenarios
A firewall policy needs to be deleted by ID.
Functions
Delete a firewall policy by ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric

id Yes uuid - - ID for deleting "ff000000-0000

a firewall -0002-
0001"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/fw/firewall_policies/ff000000-0000-0002-abce-000000000001 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.12.6 Bind a Firewall Rule to a Firewall Policy
Typical Scenarios
A firewall rule needs to be bound to a firewall policy.
Functions
Bind a Firewall Rule to a Firewall Policy.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/fw/firewall_policies/{id}/insert_rule

id Yes uuid - - ID for updating "ff000000-0000

a firewall -0002-
0001"

iMaster NCE-Fabric
Request Parameters


Updat firewall policy.
eDto
Table 1-643 FirewallPolicyUpdateDto parameters

id Yes string 0 to 36 - UUID of a "00000000-000

charac firewall policy. 0-1111-2222-0
ters. 00000000001"
firewal Yes string 0 to 36 - UUID of a "00000000-000

l_rule_i charac firewall rule. 0-1111-2222-0
d ters. 00000000002"
insert_ No string 0 to 36 - UUID of the "00000000-000

after charac rule after the 0-1111-2222-0
ters. inserted 00000000003"
firewall rule.
insert_ No string 0 to 36 - UUID of the "00000000-000

before charac rule before the 0-1111-2222-0
ters. inserted 00000000002"
firewall rule.
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/fw/firewall_policies/ff000000-0000-0002-abce-000000000001/insert_rule
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "00000000-0000-1111-2222-000000000001",
"firewall_rule_id" : "00000000-0000-1111-2222-000000000002",
"insert_after" : "00000000-0000-1111-2222-000000000003",
"insert_before" : "00000000-0000-1111-2222-000000000002"
}

iMaster NCE-Fabric
Response Parameters
Table 1-644 FirewallPolicyUpdateDto parameters

eter t Value
id string 0 to 36 - UUID of a "00000000-000

characters. firewall policy. 0-1111-2222-0
00000000001"
firewal string 0 to 36 - UUID of a "00000000-000

l_rule_i characters. firewall rule. 0-1111-2222-0
d 00000000002"
insert_ string 0 to 36 - UUID of the "00000000-000

after characters. rule after the 0-1111-2222-0
inserted 00000000003"
firewall rule.
insert_ string 0 to 36 - UUID of the "00000000-000

before characters. rule before the 0-1111-2222-0
inserted 00000000002"
firewall rule.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-1111-2222-000000000001",
"firewall_rule_id" : "00000000-0000-1111-2222-000000000002",
"insert_after" : "00000000-0000-1111-2222-000000000003",
"insert_before" : "00000000-0000-1111-2222-000000000002"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.12.7 Unbind a Firewall Rule from a Firewall Policy
Typical Scenarios
A firewall rule needs to be unbound from a firewall policy.
Functions
Unbind a firewall rule from a firewall policy.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/fw/firewall_policies/{id}/remove_rule

id Yes string - - ID for updating "ff000000-0000

a firewall -0002-
0001"
Request Parameters


Updat firewall policy.
eDto

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/fw/firewall_policies/ff000000-0000-0002-abce-000000000001/
remove_rule HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "00000000-0000-1111-2222-000000000001",
"firewall_rule_id" : "00000000-0000-1111-2222-000000000002",
"insert_after" : "00000000-0000-1111-2222-000000000003",
"insert_before" : "00000000-0000-1111-2222-000000000002"
}
Response Parameters
FirewallPolicyUpdateDto parameters, For details, see Table 1-644.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-1111-2222-000000000001",
"firewall_rule_id" : "00000000-0000-1111-2222-000000000002",
"insert_after" : "00000000-0000-1111-2222-000000000003",
"insert_before" : "00000000-0000-1111-2222-000000000002"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.13 FirewallRule
# Firewall rule operation APIs

iMaster NCE-Fabric
1.9.5.13.1 Create a Firewall Rule
Typical Scenarios
A firewall rule needs to be created.
Functions
Create a firewall rule.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/fw/firewall_rules
Request Parameters

firewal Yes REFER For details, see Firewall rule. -

lRuleD ENCE Table 1-648.
toWra
pper
Table 1-648 FirewallRuleDtoWrapper parameters


_name 255 name.
charac
ters.
firewal Yes REFER For details, see - -

lRule ENCE Table 1-649.

iMaster NCE-Fabric
Table 1-649 FirewallRuleDto parameters

id Yes uuid - - Firewall rule "ffee0000-0000

ID. This field -0000-
cannot be abce-00000000
updated. 0001"
name No string 0 to - Firewall rule "a firewall

255 name. rule"
charac
ters.
descrip No string 0 to - Firewall rule "this is firewall

tion 1024 description. rule
charac description"
ters.
firewal No string 0 to 36 - ID of a policy "9951b5fd-

l_polic charac to which a d187-4ab6-
y_id ters. firewall rule b71f-397dd193
belongs. This 2027"
field cannot be
updated.

0001"

255 firewall rule is
charac shared.
ters.
protoc Yes string 0 to 40 - Protocol. The "tcp"

ol charac value must be
ters. none, tcp, udp,
icmp, or a
integer from 1
to 255. The
value contains
a maximum of
40 bytes.
ip_vers No int32 [1-255 - IP version. 4

ion ]
source No string 0 to 64 - Source IP "192.168.9.0/24

_ip_ad charac address or "
dress ters. CIDR of a rule.

iMaster NCE-Fabric

destina No string 0 to 64 - Destination IP "192.168.10.0/2

tion_ip charac address or 4"
_addre ters. CIDR of a rule.
ss
source No string 0 to - Source IP "192.168.9.0/24

_ip_ad 26214 address or ,
dresses 4 CIDR list of a 192.168.20.0/2
charac rule. 4"
ters.
destina No string 0 to - Destination IP "192.168.10.0/2

tion_ip 26214 address or 4,192.168.20.0/
_addre 4 CIDR list of a 24"
sses charac rule.
ters.
source No string 0 to 46 - Source port. "43"

_port charac This parameter
ters. is valid only
when the
protocol is set
to tcp or udp.
Otherwise, this
parameter
must be set to
null or empty.
The type is
Integer for a
single port.
destina No string 0 to 46 - Destination "34"

tion_p charac port. This
ort ters. parameter is
valid only
when the
protocol is set
to tcp or udp.
Otherwise, this
parameter
must be set to
null or empty.
The type is
Integer for a
single port.

iMaster NCE-Fabric

source No string 0 to - Source port. "43"

_ports 256 This parameter
charac is valid only
ters. when the
protocol is set
to tcp or udp.
Otherwise, this
parameter
must be set to
null or empty.
The type is
Integer for a
single port.
destina No string 0 to - Destination "34"

tion_p 256 port. This
orts charac parameter is
ters. valid only
when the
protocol is set
to tcp or udp.
Otherwise, this
parameter
must be set to
null or empty.
The type is
Integer for a
single port.
positio No int32 [0-255 - Position of a 56

n ] rule in a policy.
The value
starts from 1. If
no policy is
bound, the
value is 0.
action No string 0 to - Rule action. "deny"

255
charac
ters.
enable No string 0 to - Whether to "true"

d 255 enable a rule.
charac
ters.

iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/fw/firewall_rules HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"firewallRule" : {
"id" : "ffee0000-0000-0000-abce-000000000001",
"description" : "this is firewall rule description",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "false",
"protocol" : "tcp",
"ip_version" : 4,
"source_ip_address" : "192.168.9.0/24",
"destination_ip_address" : "192.168.10.0/24",
"source_ip_addresses" : "192.168.9.0/24,192.168.20.0/24",
"destination_ip_addresses" : "192.168.10.0/24,192.168.20.0/24",
"source_port" : "43",
"destination_port" : "34",
"source_ports" : "43",
"destination_ports" : "34",
"position" : 56,
"action" : "deny",
"enabled" : "true"
}
}
Response Parameters
Table 1-650 FirewallRuleDtoWrapper parameters

eter t Value

firewal REFER For details, see Table - -

lRule ENCE 1-651.

iMaster NCE-Fabric
Table 1-651 FirewallRuleDto parameters

eter t Value
id uuid - - Firewall rule "ffee0000-0000

ID. This field -0000-
cannot be abce-00000000
updated. 0001"
name string 0 to 255 - Firewall rule "a firewall

characters. name. rule"
descrip string 0 to 1024 - Firewall rule "this is firewall

tion characters. description. rule
description"
firewal string 0 to 36 - ID of a policy "9951b5fd-

l_polic characters. to which a d187-4ab6-
y_id firewall rule b71f-397dd193
belongs. This 2027"
field cannot be
updated.

0001"

characters. firewall rule is
shared.
protoc string 0 to 40 - Protocol. The "tcp"

ol characters. value must be
none, tcp, udp,
icmp, or a
integer from 1
to 255. The
value contains
a maximum of
40 bytes.
ip_vers int32 [1-255] - IP version. 4

ion
source string 0 to 64 - Source IP "192.168.9.0/24

_ip_ad characters. address or "
dress CIDR of a rule.
destina string 0 to 64 - Destination IP "192.168.10.0/2

tion_ip characters. address or 4"
_addre CIDR of a rule.
ss

iMaster NCE-Fabric

eter t Value
source string 0 to 262144 - Source IP "192.168.9.0/24

_ip_ad characters. address or ,
dresses CIDR list of a 192.168.20.0/2
rule. 4"
destina string 0 to 262144 - Destination IP "192.168.10.0/2

tion_ip characters. address or 4,192.168.20.0/
_addre CIDR list of a 24"
sses rule.
source string 0 to 46 - Source port. "43"

_port characters. This parameter
is valid only
when the
protocol is set
to tcp or udp.
Otherwise, this
parameter
must be set to
null or empty.
The type is
Integer for a
single port.
destina string 0 to 46 - Destination "34"

tion_p characters. port. This
ort parameter is
valid only
when the
protocol is set
to tcp or udp.
Otherwise, this
parameter
must be set to
null or empty.
The type is
Integer for a
single port.

iMaster NCE-Fabric

eter t Value
source string 0 to 256 - Source port. "43"

_ports characters. This parameter
is valid only
when the
protocol is set
to tcp or udp.
Otherwise, this
parameter
must be set to
null or empty.
The type is
Integer for a
single port.
destina string 0 to 256 - Destination "34"

tion_p characters. port. This
orts parameter is
valid only
when the
protocol is set
to tcp or udp.
Otherwise, this
parameter
must be set to
null or empty.
The type is
Integer for a
single port.
positio int32 [0-255] - Position of a 56

n rule in a policy.
The value
starts from 1. If
no policy is
bound, the
value is 0.
action string 0 to 255 - Rule action. "deny"

characters.
enable string 0 to 255 - Whether to "true"

d characters. enable a rule.

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewallRule" : {
"id" : "ffee0000-0000-0000-abce-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "false",
"protocol" : "tcp",
"ip_version" : 4,
"position" : 56,
"action" : "deny",
"enabled" : "true"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.13.2 Query All Firewall Rules
Typical Scenarios
All firewall rules need to be queried.
Functions
Query all firewall rules.

iMaster NCE-Fabric
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/fw/firewall_rules


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/fw/firewall_rules?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-653 FirewallRuleQueryOutputDto parameters

eter t Value
firewal ARRAY 0-255 items. For details, - -

lRule _REFER see Table 1-651.
ENCE

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewallRule" : [
{
"id" : "ffee0000-0000-0000-abce-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "false",
"protocol" : "tcp",
"ip_version" : 4,
"position" : 56,
"action" : "deny",
"enabled" : "true"
}
],
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.13.3 Query a Firewall Rule by ID
Typical Scenarios
A firewall rule needs to be queried by ID.
Functions
Query a firewall rule by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/fw/firewall_rules/{id}

id Yes uuid - - ID for querying "ffee0000-0000

a firewall rule. -0000-
abce-00000000
0001"
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/fw/firewall_rules/ffee0000-0000-0000-abce-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
FirewallRuleDtoWrapper parameters, For details, see Table 1-650.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewallRule" : {
"id" : "ffee0000-0000-0000-abce-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "false",
"protocol" : "tcp",
"ip_version" : 4,
"position" : 56,
"action" : "deny",
"enabled" : "true"
}
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.13.4 Update a Firewall Rule by ID
Typical Scenarios
A firewall rule needs to be updated by ID.
Functions
Update a firewall rule by ID.
Constraints
HTTP Method
PUT
URI

id Yes uuid - - ID for updating "ffee0000-0000

abce-00000000
0001"

iMaster NCE-Fabric
Request Parameters

firewal Yes REFER For details, see Firewall rule. -

lRuleD ENCE Table 1-648.
toWra
pper
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/fw/firewall_rules/ffee0000-0000-0000-abce-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"firewallRule" : {
"id" : "ffee0000-0000-0000-abce-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "false",
"protocol" : "tcp",
"ip_version" : 4,
"position" : 56,
"action" : "deny",
"enabled" : "true"
}
}
Response Parameters
FirewallRuleDtoWrapper parameters, For details, see Table 1-650.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"firewallRule" : {
"id" : "ffee0000-0000-0000-abce-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "false",
"protocol" : "tcp",
"ip_version" : 4,
"position" : 56,
"action" : "deny",
"enabled" : "true"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.13.5 Delete a Firewall Rule by ID
Typical Scenarios
A firewall rule needs to be deleted by ID.
Functions
Delete a firewall rule by ID.

iMaster NCE-Fabric
Constraints
HTTP Method
DELETE
URI

id Yes uuid - - ID for deleting "ffee0000-0000

abce-00000000
0001"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/fw/firewall_rules/ffee0000-0000-0000-abce-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.14 VPN Service

# VPN service operation APIs
1.9.5.14.1 Create a VPN Service
Typical Scenarios
A VPN service needs to be created.
Functions
Create a VPN service.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/vpn/vpnservices

iMaster NCE-Fabric
Request Parameters

vpnser Yes REFER For details, see Parameters for -

viceDt ENCE Table 1-659. creating a VPN
oWrap service.
per
Table 1-659 VPNServiceDtoWrapper parameters


ters. updated.
vpnser Yes REFER For details, see - -

vice ENCE Table 1-660.
Table 1-660 VPNServiceDto parameters

id Yes uuid - - VPN service ID. "90000000-000

This field 0-0000-0000-0
cannot be 00000000001"
updated.

0001"
name No string 0 to - VPN service "vpn_001"

255 name.
charac
ters.
descrip No string 0 to - VPN service "vpn

charac
ters.

iMaster NCE-Fabric

local_a No string 0 to - Huawei "192.168.200.2

ddress 255 proprietary "
charac field. It
ters. specifies the
public IP
address of the
local VPN
gateway.
Before creating
a VPN service,
add the
corresponding
port (specified
IP address).
This is a
backfilling
attribute. The
system queries
the value of
this parameter
based on the
router ID and
fills the value
in the
response.
subnet Yes array< 0-255 - Local subnet ID ["20000000-00

_ids string> items. list of the VPN 00-0000-0000-
Each service tunnel. 000000000021
item IDs of all "]
has 0 subnets
to 255 associated with
charac the router are
ters. included by
default. This
field cannot be
updated.
router_ Yes uuid - - ID of the "30000000-000

id router used by 0-0000-0000-0
a VPN service. 00000000001"
This field
cannot be
updated.
status No string 0 to - VPN service "true"

255 status.
charac
ters.

iMaster NCE-Fabric


_state_ 255 status of a VPN
up charac service. If the
ters. value is false,
the port does
not forward
data packets.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/vpn/vpnservices HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vpnservice" : {
"id" : "90000000-0000-0000-0000-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "vpn_001",
"description" : "vpn description",
"local_address" : "192.168.200.2",
"subnet_ids" : ["20000000-0000-0000-0000-000000000021"],
"router_id" : "30000000-0000-0000-0000-000000000001",
"status" : "true",
"admin_state_up" : "true"
}
}
Response Parameters
Table 1-661 VPNServiceDtoWrapper parameters

eter t Value

field cannot be
updated.
vpnser REFER For details, see Table - -

vice ENCE 1-662.

iMaster NCE-Fabric
Table 1-662 VPNServiceDto parameters

eter t Value
id uuid - - VPN service ID. "90000000-000

This field 0-0000-0000-0
cannot be 00000000001"
updated.

0001"
name string 0 to 255 - VPN service "vpn_001"

characters. name.
descrip string 0 to 255 - VPN service "vpn

local_a string 0 to 255 - Huawei "192.168.200.2

ddress characters. proprietary "
field. It
specifies the
public IP
address of the
local VPN
gateway.
Before creating
a VPN service,
add the
corresponding
port (specified
IP address).
This is a
backfilling
attribute. The
system queries
the value of
this parameter
based on the
router ID and
fills the value
in the
response.

iMaster NCE-Fabric

eter t Value
subnet array< 0-255 items. - Local subnet ID ["20000000-00

_ids string> Each item has 0 list of the VPN 00-0000-0000-
to 255 service tunnel. 000000000021
characters. IDs of all "]
subnets
associated with
the router are
included by
default. This
field cannot be
updated.
router_ uuid - - ID of the "30000000-000

id router used by 0-0000-0000-0
a VPN service. 00000000001"
This field
cannot be
updated.
status string 0 to 255 - VPN service "true"

characters. status.

_state_ characters. status of a VPN
up service. If the
value is false,
the port does
not forward
data packets.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{

iMaster NCE-Fabric
"vpnservice" : {
"id" : "90000000-0000-0000-0000-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "vpn_001",
"local_address" : "192.168.200.2",
"subnet_ids" : ["20000000-0000-0000-0000-000000000021"],
"router_id" : "30000000-0000-0000-0000-000000000001",
"status" : "true",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.14.2 Query All VPN Services
Typical Scenarios
All VPN services need to be queried.
Functions
Query all VPN services.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/vpn/vpnservices

iMaster NCE-Fabric


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/vpn/vpnservices?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-664 VPNServiceQueryOutputDto parameters

eter t Value
vpnser ARRAY 0-255 items. For details, VPN service. -

vice _REFER see Table 1-662.
ENCE

numbe int32 [0-2147483647 - Number. 1

r ]

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpnservice" : [
{
"id" : "90000000-0000-0000-0000-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "vpn_001",
"local_address" : "192.168.200.2",
"subnet_ids" : ["20000000-0000-0000-0000-000000000021"],
"router_id" : "30000000-0000-0000-0000-000000000001",
"status" : "true",
}
],
"number" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.14.3 Query a VPN Service by ID
Typical Scenarios
A VPN service needs to be queried by ID.
Functions
Query a VPN service by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/vpn/vpnservices/{id}

id Yes uuid - - ID for querying "90000000-000

a VPN service. 0-0000-0000-0
00000000001"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/vpn/vpnservices/90000000-0000-0000-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
VPNServiceDtoWrapper parameters, For details, see Table 1-661.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"vpnservice" : {
"id" : "90000000-0000-0000-0000-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "vpn_001",
"local_address" : "192.168.200.2",
"subnet_ids" : ["20000000-0000-0000-0000-000000000021"],
"router_id" : "30000000-0000-0000-0000-000000000001",
"status" : "true",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.14.4 Update a VPN Service by ID
Typical Scenarios
A VPN service needs to be updated by ID.
Functions
Update a VPN service by ID.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes uuid - - ID for updating "90000000-000

a VPN service. 0-0000-0000-0
00000000001"
Request Parameters

vpnser Yes REFER For details, see Parameters for -

viceDt ENCE Table 1-659. updating a
oWrap VPN service.
per
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/vpn/vpnservices/90000000-0000-0000-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vpnservice" : {
"id" : "90000000-0000-0000-0000-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "vpn_001",
"local_address" : "192.168.200.2",
"subnet_ids" : ["20000000-0000-0000-0000-000000000021"],
"router_id" : "30000000-0000-0000-0000-000000000001",
"status" : "true",
}
}
Response Parameters

iMaster NCE-Fabric

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpnservice" : {
"id" : "90000000-0000-0000-0000-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "vpn_001",
"local_address" : "192.168.200.2",
"subnet_ids" : ["20000000-0000-0000-0000-000000000021"],
"router_id" : "30000000-0000-0000-0000-000000000001",
"status" : "true",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.14.5 Delete a VPN Service by ID
Typical Scenarios
A VPN service needs to be deleted by ID.
Functions
Delete a VPN service by ID.
Constraints

iMaster NCE-Fabric

HTTP Method
DELETE
URI

id Yes uuid - - Parameters for "90000000-000

deleting a VPN 0-0000-0000-0
service. 00000000001"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/vpn/vpnservices/90000000-0000-0000-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpnservice" : {
"id" : "90000000-0000-0000-0000-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "vpn_001",
"local_address" : "192.168.200.2",
"subnet_ids" : ["20000000-0000-0000-0000-000000000021"],
"router_id" : "30000000-0000-0000-0000-000000000001",
"status" : "true",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.15 IkePolicy
# IKE policy operation APIs
1.9.5.15.1 Create an IKE Policy
Typical Scenarios
An IKE policy needs to be created.
Functions
Create an IKE policy.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/vpn/ikepolicies
Request Parameters

ikePoli Yes REFER For details, see IKE policy. -

cyDto ENCE Table 1-670.
Wrapp
er
Table 1-670 IkePolicyDtoWrapper parameters


ters. updated.
ikepoli Yes REFER For details, see IKE policy -

cy ENCE Table 1-671. object.
Table 1-671 IkePolicyDto parameters

id Yes string - - UUID. This field "00000000-000

cannot be 0-0000-1234-0
updated. 00000000001"

0001"

iMaster NCE-Fabric

name No string 0 to - IKE policy "IkePolicy"

255 name.
charac
ters.
descrip No string 0 to - IKE policy "description

tion 256 description. info"
charac
ters.
shared No string 0 to - Whether the "true"

255 key exchange
charac policy supports
ters. cross-tenant
● true sharing.
● fals
e
auth_a Yes string 0 to - Hash algorithm "sha2"

lgorith 255 for
m charac authentication.
ters. This field
cannot be
updated.
encryp Yes string 0 to - Encryption "aes-128"

tion_al 255 algorithm.
gorith charac
m ters.
phase_ Yes string 0 to - IKE negotiation "main"

negoti 255 mode. This
ation_ charac field cannot be
mode ters. updated.
pfs Yes string 0 to - Perfect forward "group1"

255 secrecy (PFS)
charac used in the IKE
ters. negotiation
phase.
ike_ver Yes string 0 to - IKE version. "v1"

sion 255
charac
ters.
lifetim Yes REFER For details, see Lifecycle. -

e ENCE Table 1-672.

iMaster NCE-Fabric
Table 1-672 IKEPolicyLifetimeDto parameters

units No string 0 to - SA lifetime "second"

255 unit. This field
charac cannot be
ters. updated.
value No int32 [60-60 - SA lifetime. 60

4800] This field
cannot be
updated.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/vpn/ikepolicies HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"ikepolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "IkePolicy",
"description" : "description info",
"shared" : "true",
"auth_algorithm" : "sha2",
"encryption_algorithm" : "aes-128",
"phase_negotiation_mode" : "main",
"pfs" : "group1",
"ike_version" : "v1",
"lifetime" : {
"units" : "second",
"value" : 60
}
}
}
Response Parameters

iMaster NCE-Fabric
Table 1-673 IkePolicyDtoWrapper parameters

eter t Value

field cannot be
updated.
ikepoli REFER For details, see Table IKE policy -

cy ENCE 1-674. object.
Table 1-674 IkePolicyDto parameters

eter t Value
id string - - UUID. This field "00000000-000

cannot be 0-0000-1234-0
updated. 00000000001"

0001"
name string 0 to 255 - IKE policy "IkePolicy"

characters. name.
descrip string 0 to 256 - IKE policy "description

tion characters. description. info"
shared string 0 to 255 - Whether the "true"

characters. key exchange
● true policy supports
● false cross-tenant
sharing.
auth_a string 0 to 255 - Hash algorithm "sha2"

lgorith characters. for
m authentication.
This field
cannot be
updated.
encryp string 0 to 255 - Encryption "aes-128"

tion_al characters. algorithm.
gorith
m

iMaster NCE-Fabric

eter t Value
phase_ string 0 to 255 - IKE negotiation "main"

negoti characters. mode. This
ation_ field cannot be
mode updated.
pfs string 0 to 255 - Perfect forward "group1"

characters. secrecy (PFS)
used in the IKE
negotiation
phase.
ike_ver string 0 to 255 - IKE version. "v1"

sion characters.
lifetim REFER For details, see Table Lifecycle. -

e ENCE 1-675.
Table 1-675 IKEPolicyLifetimeDto parameters

eter t Value
units string 0 to 255 - SA lifetime "second"

characters. unit. This field
cannot be
updated.
value int32 [60-604800] - SA lifetime. 60

This field
cannot be
updated.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"ikepolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"units" : "second",
"value" : 60
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.15.2 Query All IKE Policies
Typical Scenarios
All IKE polices need to be queried.
Functions
Query all IKE policies.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v2/neutronapi/vpn/ikepolicies


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/vpn/ikepolicies?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-677 IkePolicyQueryOutputDto parameters

eter t Value
ikepoli ARRAY 0-255 items. For details, IKE policy. -

cy _REFER see Table 1-674.
ENCE


iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ikepolicy" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"units" : "second",
"value" : 60
}
}
],
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.15.3 Query an IKE Policy by ID
Typical Scenarios
An IKE policy needs to be queried by ID.
Functions
Query an IKE policy by ID.

iMaster NCE-Fabric
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/vpn/ikepolicies/{id}

id Yes string 0 to 36 - IKE policy ID. "00000000-000

charac 0-0000-1234-0
ters. 00000000111"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/vpn/ikepolicies/00000000-0000-0000-1234-000000000111 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
IkePolicyDtoWrapper parameters, For details, see Table 1-673.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ikepolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"units" : "second",
"value" : 60
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.15.4 Update an IKE Policy by ID
Typical Scenarios
An IKE policy needs to be updated by ID.
Functions
Update an IKE policy.
Constraints

iMaster NCE-Fabric
HTTP Method
PUT
URI


charac 0-0000-1234-0
ters. 00000000111"
Request Parameters

body Yes REFER For details, see IKE policy. -

ENCE Table 1-670.
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/vpn/ikepolicies/00000000-0000-0000-1234-000000000111 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"ikepolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"units" : "second",

iMaster NCE-Fabric
"value" : 60
}
}
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ikepolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"units" : "second",
"value" : 60
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.15.5 Delete an IKE Policy by ID
Typical Scenarios
An IKE policy needs to be deleted by ID.
Functions
Delete an IKE policy by ID.
Constraints
HTTP Method
DELETE
URI


charac 0-0000-1234-0
ters. 00000000111"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/vpn/ikepolicies/00000000-0000-0000-1234-000000000111 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ikepolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"units" : "second",
"value" : 60
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.5.16 IPsecPolicy
# IPsec policy operation APIs
1.9.5.16.1 Create an IPsec Policy by ID
Typical Scenarios
An IPsec policy needs to be created by ID.
Functions
Create an IPSec policy by ID.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/vpn/ipsecpolicies
Request Parameters

ipsecP Yes REFER For details, see IPsec policy. -

olicyDt ENCE Table 1-683.
oWrap
per
Table 1-683 IpsecPolicyDtoWrapper parameters


ters. updated.

iMaster NCE-Fabric

ipsecp Yes REFER For details, see IPsec policy -

olicy ENCE Table 1-684. object.
Table 1-684 IpsecPolicyDto parameters

id Yes string 0 to 36 - IPsec policy ID. "00000000-000

charac This field 0-0000-1234-0
updated.

0001"
name No string 0 to - IPsec policy "IPSec Policy1"

255 name.
charac
ters.
descrip No string 0 to - Description. "description"

tion 255
charac
ters.
shared No string 0 to - Whether cross- "true"

255 tenant sharing
charac is supported.
ters.
● true
● fals
e
transfo Yes string 0 to - Transmission "esp"

rm_pro 255 protocol.
tocol charac
ters.
encaps Yes string 0 to - Encapsulation "transport"

ulation 255 mode.
_mode charac
ters.

iMaster NCE-Fabric

auth_a Yes string 0 to - Hash algorithm "sha2-256"

lgorith 255 for
m charac authentication.
ters. This field
cannot be
updated.
encryp Yes string 0 to - Encryption "aes-128"

tion_al 255 algorithm.
gorith charac
m ters.
pfs Yes string 0 to - Perfect forward "group1"

255 secrecy (PFS)
charac used in the IKE
ters. negotiation
phase.
lifetim Yes REFER For details, see Lifecycle. -

e ENCE Table 1-685.
Table 1-685 IpsecPolicyLifetimeDto parameters

units Yes string 0 to - SA lifetime "seconds"

255 unit. This field
charac cannot be
ters. updated.
value Yes int32 [60-60 - SA lifetime. 60

4800] This field
cannot be
updated.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/vpn/ipsecpolicies HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{

iMaster NCE-Fabric
"ipsecpolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "IPSec Policy1",
"shared" : "true",
"transform_protocol" : "esp",
"encapsulation_mode" : "transport",
"auth_algorithm" : "sha2-256",
"pfs" : "group1",
"lifetime" : {
"units" : "seconds",
"value" : 60
}
}
}
Response Parameters
Table 1-686 IpsecPolicyDtoWrapper parameters

eter t Value

field cannot be
updated.
ipsecp REFER For details, see Table IPsec policy -

olicy ENCE 1-687. object.
Table 1-687 IpsecPolicyDto parameters

eter t Value
id string 0 to 36 - IPsec policy ID. "00000000-000

characters. This field 0-0000-1234-0
cannot be 00000000001"
updated.

0001"
name string 0 to 255 - IPsec policy "IPSec Policy1"

characters. name.
descrip string 0 to 255 - Description. "description"

tion characters.

iMaster NCE-Fabric

eter t Value
shared string 0 to 255 - Whether cross- "true"

characters. tenant sharing
● true is supported.
● false
transfo string 0 to 255 - Transmission "esp"

rm_pro characters. protocol.
tocol
encaps string 0 to 255 - Encapsulation "transport"

ulation characters. mode.
_mode
auth_a string 0 to 255 - Hash algorithm "sha2-256"

lgorith characters. for
m authentication.
This field
cannot be
updated.
encryp string 0 to 255 - Encryption "aes-128"

tion_al characters. algorithm.
gorith
m
pfs string 0 to 255 - Perfect forward "group1"

characters. secrecy (PFS)
used in the IKE
negotiation
phase.
lifetim REFER For details, see Table Lifecycle. -

e ENCE 1-688.
Table 1-688 IpsecPolicyLifetimeDto parameters

eter t Value
units string 0 to 255 - SA lifetime "seconds"

characters. unit. This field
cannot be
updated.
value int32 [60-604800] - SA lifetime. 60

This field
cannot be
updated.

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ipsecpolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"value" : 60
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.16.2 Query All IPsec Policies
Typical Scenarios
All IPsec policies need to be queried.

iMaster NCE-Fabric
Functions
Query all IPSec policies.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/vpn/ipsecpolicies


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/vpn/ipsecpolicies?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-690 IpsecPolicyQueryOutputDto parameters

eter t Value
ipsecp ARRAY 0-255 items. For details, IPsec policy. -

olicy _REFER see Table 1-687.
ENCE

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ipsecpolicy" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"value" : 60
}
}
],
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.16.3 Query an IPsec Policy by ID
Typical Scenarios
An IPsec policy needs to be queried by ID.
Functions
Query an IPSec policy by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/vpn/ipsecpolicies/{id}

id Yes uuid - - IPsec policy ID. "00000000-000

0-0000-1234-0
00000000001"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/vpn/ipsecpolicies/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
IpsecPolicyDtoWrapper parameters, For details, see Table 1-686.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ipsecpolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"value" : 60
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.16.4 Update an IPsec Policy by ID
Typical Scenarios
An IPsec policy needs to be updated by name.
Functions
Update an IPsec policy by name.
Constraints
HTTP Method
PUT
URI


0-0000-1234-0
00000000001"
Request Parameters

ipsecP Yes REFER For details, see IPsec policy. -

olicyDt ENCE Table 1-683.
oWrap
per

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/vpn/ipsecpolicies/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"ipsecpolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",
"pfs" : "group1",
"lifetime" : {
"value" : 60
}
}
}
Response Parameters
IpsecPolicyDtoWrapper parameters, For details, see Table 1-686.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ipsecpolicy" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"shared" : "true",

iMaster NCE-Fabric
"pfs" : "group1",
"lifetime" : {
"value" : 60
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.16.5 Delete an IPsec Policy by ID
Typical Scenarios
An IPsec policy needs to be deleted by ID.
Functions
Delete an IPSec policy by ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric


0-0000-1234-0
00000000001"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/vpn/ipsecpolicies/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.17 Ipsec Site Connection

# IPsec site connection operation APIs
1.9.5.17.1 Create an IPsec Site Connection
Typical Scenarios
An IPsec site connection needs to be created by ID after the IKE policies, IPsec
policies, and VPN services are created.
Functions
Create an IPSec site connection.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/vpn/ipsec-site-connections
Request Parameters

ipsecC Yes REFER For details, see IPsec site -

onnect ENCE Table 1-696. connection.
ionDto
Wrapp
er

iMaster NCE-Fabric
Table 1-696 IpsecConnectionDtoWrapper parameters


ters. updated.
ipsec_s Yes REFER For details, see IPSec site -

ite_con ENCE Table 1-697. connection
nectio object.
n
Table 1-697 IpsecConnectionDto parameters

id Yes string 0 to 36 - IPsec site "00000000-000

charac connection ID. 0-0000-1234-0
ters. This field 00000000001"
cannot be
updated.

0001"
name No string 0 to - IPsec site "IpSecConnecti

255 connection on1"
charac name.
ters.
descrip No string 0 to - Description. "This is an

tion 256 IpsecConnectio
charac n."
ters.
peer_a Yes string 0 to - Public IP "192.168.1.1"

ddress 255 address or
charac FQDN of the
ters. peer VPN
gateway.

iMaster NCE-Fabric

peer_id Yes string 0 to - Peer VPN ID, "00000000-000

255 which can be a 0-0000-1111-0
charac name, 00000000001"
ters. character
string, or
FQDN.
peer_ci Yes array< 0-255 - Peer private ["192.168.2.0/2

drs string> items. CIDR list. 4"]
route_ Yes string 0 to - Route mode. "static"

mode 255 This field
charac cannot be
ters. updated.
mtu Yes int32 68 to - Maximum 100

1500 transmission
charac unit.
ters.
[68-15
00]
auth_ Yes string 0 to - Authentication "psk"

mode 255 mode. This
ters. updated.
psk Yes string 0 to - This field may "psk123"

255 contain
charac sensitive or
Keep it secure.
Pre-shared key
(PSK).
initiato Yes string 0 to - Interaction "bi-directional"

r 255 mode between
charac the VPN and
ters. IPsec
connection.
admin No string 0 to - VPN "true"

_state_ 255 connection
up charac administrative
ters. status.
● true
● fals
e

iMaster NCE-Fabric

status No string 0 to - Connectivity "ACTIVE"

255 status.
charac
ters.
ikepoli Yes string 0 to 36 - IKE policy ID. "00000000-000

cy_id charac This field 0-0000-1234-0
updated.
ipsecp Yes string 0 to 36 - IPsec policy ID. "00000000-000

olicy_i charac This field 0-0000-1234-0
d ters. cannot be 00000000011"
updated.
vpnser Yes string 0 to 36 - VPN service ID. "00000000-000

vice_id charac This field 0-0000-1234-0
updated.
dpd Yes REFER For details, see DPD object. -

ENCE Table 1-698.
Table 1-698 DpdDto parameters

action Yes string 0 to - DPD detection "hold"

255 type.
charac
ters.
interva Yes int32 [1-655 - Interval for 60

l 35] triggering DPD.
timeou Yes int32 [1-655 - Interval for 70

t 35] retransmitting
DPD packets.
The value must
be greater than
the interval
value.
Sample Request
HTTP

iMaster NCE-Fabric
POST /controller/dc/v2/neutronapi/vpn/ipsec-site-connections HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"ipsec_site_connection" : {
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"name" : "IpSecConnection1",
"description" : "This is an IpsecConnection.",
"peer_address" : "192.168.1.1",
"peer_id" : "00000000-0000-0000-1111-000000000001",
"peer_cidrs" : ["192.168.2.0/24"],
"route_mode" : "static",
"mtu" : 100,
"auth_mode" : "psk",
"psk" : "psk123",
"initiator" : "bi-directional",
"ikepolicy_id" : "00000000-0000-0000-1234-000000000010",
"ipsecpolicy_id" : "00000000-0000-0000-1234-000000000011",
"vpnservice_id" : "00000000-0000-0000-1234-000000000012",
"dpd" : {
"action" : "hold",
"interval" : 60,
"timeout" : 70
}
}
}
Response Parameters
Table 1-699 IpsecConnectionDtoWrapper parameters

eter t Value

field cannot be
updated.
ipsec_s REFER For details, see Table IPSec site -

ite_con ENCE 1-700. connection
nectio object.
n

iMaster NCE-Fabric
Table 1-700 IpsecConnectionDto parameters

eter t Value
id string 0 to 36 - IPsec site "00000000-000

characters. connection ID. 0-0000-1234-0
This field 00000000001"
cannot be
updated.

0001"
name string 0 to 255 - IPsec site "IpSecConnecti

characters. connection on1"
name.
descrip string 0 to 256 - Description. "This is an

tion characters. IpsecConnectio
n."
peer_a string 0 to 255 - Public IP "192.168.1.1"

ddress characters. address or
FQDN of the
peer VPN
gateway.
peer_id string 0 to 255 - Peer VPN ID, "00000000-000

characters. which can be a 0-0000-1111-0
name, 00000000001"
character
string, or
FQDN.
peer_ci array< 0-255 items. - Peer private ["192.168.2.0/2

drs string> CIDR list. 4"]
route_ string 0 to 255 - Route mode. "static"

mode characters. This field
cannot be
updated.
mtu int32 68 to 1500 - Maximum 100

characters. transmission
[68-1500] unit.
auth_ string 0 to 255 - Authentication "psk"

mode characters. mode. This
field cannot be
updated.

iMaster NCE-Fabric

eter t Value
psk string 0 to 255 - This field may "psk123"

characters. contain
sensitive or
personal data.
Keep it secure.
Pre-shared key
(PSK).
initiato string 0 to 255 - Interaction "bi-directional"

r characters. mode between
the VPN and
IPsec
connection.
admin string 0 to 255 - VPN "true"

_state_ characters. connection
up ● true administrative
● false status.
status string 0 to 255 - Connectivity "ACTIVE"

characters. status.
ikepoli string 0 to 36 - IKE policy ID. "00000000-000

cy_id characters. This field 0-0000-1234-0
cannot be 00000000010"
updated.
ipsecp string 0 to 36 - IPsec policy ID. "00000000-000

olicy_i characters. This field 0-0000-1234-0
d cannot be 00000000011"
updated.
vpnser string 0 to 36 - VPN service ID. "00000000-000

vice_id characters. This field 0-0000-1234-0
cannot be 00000000012"
updated.
dpd REFER For details, see Table DPD object. -

ENCE 1-701.
Table 1-701 DpdDto parameters

eter t Value
action string 0 to 255 - DPD detection "hold"

characters. type.

iMaster NCE-Fabric

eter t Value
interva int32 [1-65535] - Interval for 60

l triggering DPD.
timeou int32 [1-65535] - Interval for 70

t retransmitting
DPD packets.
The value must
be greater than
the interval
value.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"peer_address" : "192.168.1.1",
"peer_id" : "00000000-0000-0000-1111-000000000001",
"peer_cidrs" : ["192.168.2.0/24"],
"mtu" : 100,
"psk" : "psk123",
"ikepolicy_id" : "00000000-0000-0000-1234-000000000010",
"ipsecpolicy_id" : "00000000-0000-0000-1234-000000000011",
"vpnservice_id" : "00000000-0000-0000-1234-000000000012",
"dpd" : {
"action" : "hold",
"interval" : 60,
"timeout" : 70
}
}
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.17.2 Query All IPsec Site Connections
Typical Scenarios
All IPsec connections need to be queried.
Functions
Query all IPSec site connections.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/vpn/ipsec-site-connections


dex number.

ze

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/vpn/ipsec-site-connections?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-703 IpsecConnectionQueryOutputDto parameters

eter t Value
ipsec_s ARRAY 0-255 items. For details, List of IPSec -

ite_con _REFER see Table 1-700. site connection
nectio ENCE objects.
n

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ipsec_site_connection" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",

iMaster NCE-Fabric

"peer_address" : "192.168.1.1",
"peer_id" : "00000000-0000-0000-1111-000000000001",
"peer_cidrs" : ["192.168.2.0/24"],
"mtu" : 100,
"psk" : "psk123",
"ikepolicy_id" : "00000000-0000-0000-1234-000000000010",
"ipsecpolicy_id" : "00000000-0000-0000-1234-000000000011",
"vpnservice_id" : "00000000-0000-0000-1234-000000000012",
"dpd" : {
"action" : "hold",
"interval" : 60,
"timeout" : 70
}
}
],
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.17.3 Query an IPsec Site Connection by ID
Typical Scenarios
An IPsec site connection needs to be queried by ID.
Functions
Query an IPSec site connection.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v2/neutronapi/vpn/ipsec-site-connections/{id}

id Yes uuid - - IPsec site "00000000-000

connection ID. 0-0000-1234-0
00000000001"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/vpn/ipsec-site-connections/00000000-0000-0000-1234-000000000001
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
IpsecConnectionDtoWrapper parameters, For details, see Table 1-699.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{

iMaster NCE-Fabric
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"peer_address" : "192.168.1.1",
"peer_id" : "00000000-0000-0000-1111-000000000001",
"peer_cidrs" : ["192.168.2.0/24"],
"mtu" : 100,
"psk" : "psk123",
"ikepolicy_id" : "00000000-0000-0000-1234-000000000010",
"ipsecpolicy_id" : "00000000-0000-0000-1234-000000000011",
"vpnservice_id" : "00000000-0000-0000-1234-000000000012",
"dpd" : {
"action" : "hold",
"interval" : 60,
"timeout" : 70
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.17.4 Update an IPsec Site Connection by ID
Typical Scenarios
An IPsec site connection needs to be updated by ID.
Functions
Update an IPSec site connection by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
PUT
URI

id Yes uuid - - ID of a new "00000000-000

IPsec site. 0-0000-1234-0
00000000001"
Request Parameters

ipsecC Yes REFER For details, see IPsec site -

onnect ENCE Table 1-696. connection.
ionDto
Wrapp
er
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/vpn/ipsec-site-connections/00000000-0000-0000-1234-000000000001
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"peer_address" : "192.168.1.1",
"peer_id" : "00000000-0000-0000-1111-000000000001",
"peer_cidrs" : ["192.168.2.0/24"],
"mtu" : 100,

iMaster NCE-Fabric
"psk" : "psk123",
"ikepolicy_id" : "00000000-0000-0000-1234-000000000010",
"ipsecpolicy_id" : "00000000-0000-0000-1234-000000000011",
"vpnservice_id" : "00000000-0000-0000-1234-000000000012",
"dpd" : {
"action" : "hold",
"interval" : 60,
"timeout" : 70
}
}
}
Response Parameters
IpsecConnectionDtoWrapper parameters, For details, see Table 1-699.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-0000-1234-000000000001",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"peer_address" : "192.168.1.1",
"peer_id" : "00000000-0000-0000-1111-000000000001",
"peer_cidrs" : ["192.168.2.0/24"],
"mtu" : 100,
"psk" : "psk123",
"ikepolicy_id" : "00000000-0000-0000-1234-000000000010",
"ipsecpolicy_id" : "00000000-0000-0000-1234-000000000011",
"vpnservice_id" : "00000000-0000-0000-1234-000000000012",
"dpd" : {
"action" : "hold",
"interval" : 60,
"timeout" : 70
}
}
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.17.5 Delete an IPsec Site Connection by ID
Typical Scenarios
An IPsec site connection needs to be deleted by ID.
Functions
Delete an IPSec site connection by ID.
Constraints
HTTP Method
DELETE
URI

id Yes uuid - - IPsec site "00000000-000

connection ID. 0-0000-1234-0
00000000001"

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/vpn/ipsec-site-connections/00000000-0000-0000-1234-000000000001
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.18 L2BR
# L2BR operation APIs

iMaster NCE-Fabric
1.9.5.18.1 Create L2BRs in Batches
Typical Scenarios
L2BRs need to be created in batches.
Functions
Create L2BRs in batches.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/l2brs/action/batch-create
Request Parameters

l2brBat Yes REFER For details, see L2BR list. -

chReq ENCE Table 1-709.
uest
Table 1-709 L2brBatchRequest parameters


_name 255 name.
charac
ters.
l2br Yes ARRAY 0-255 items. For L2BR list. -

_REFER details, see
ENCE Table 1-710.

iMaster NCE-Fabric
Table 1-710 L2brDto parameters

id Yes uuid - - UUID. This field "00000000-000

cannot be 0-0000-1234-0
updated. 00000000001"
name No string 0 to - L2BR name. "l2br1"

255
charac
ters.

0001"
device_ Yes REFER For details, see Device -

info ENCE Table 1-711. information.
service Yes REFER For details, see Service -

_info ENCE Table 1-712. information.
Table 1-711 L2BRDeviceInfoDto parameters

interfa No string 0 to - Interface "10GE1/0/21"

ce_na 255 name.
me charac
ters.
device_ No string 0 to - Device name. "CE6850_37.12

name 255 Only one of "
charac the device
ters. name, device IP
address, and
device MAC
address can
and must be
set.

iMaster NCE-Fabric

device_ No string 0 to - Device IP "10.6.54.60"

ip 255 address. Only
charac one of the
ters. device name,
device IP
address, and
device MAC
address can
and must be
set.
device_ No string 0 to - Device MAC "00:50:56:84:7D

mac 255 address. Only :91"
charac one of the
ters. device name,
device IP
address, and
device MAC
address can
and must be
set.
host No string 0 to - Host name. "192.168.62.1"

255
charac
ters.
Table 1-712 ServiceInfoDto parameters

networ No string 0 to 36 - Network ID. "00000000-000

k_id charac Either vni or 0-0000-1234-0
ters. network must 00000000010"
be set.
vni No int32 [1-160 - VNI value. 15000

00000] Either vni or
network must
be set.
vlan_id Yes int32 [0-409 - VLAN ID. 16

4]

iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/l2brs/action/batch-create HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"l2br" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"interface_name" : "10GE1/0/21",
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
]
}
Response Parameters
Table 1-713 L2brBatchResponse parameters

eter t Value

success ARRAY 0-255 items. For details, Success list. -

ENCE
fail ARRAY 0-255 items. For details, List of failed -

_REFER see Table 1-717. issues.
ENCE

iMaster NCE-Fabric
Table 1-714 L2brDto parameters

eter t Value
id uuid - - UUID. This field "00000000-000

cannot be 0-0000-1234-0
updated. 00000000001"
name string 0 to 255 - L2BR name. "l2br1"

characters.

0001"
device_ REFER For details, see Table Device -

info ENCE 1-715. information.
service REFER For details, see Table Service -

_info ENCE 1-716. information.
Table 1-715 L2BRDeviceInfoDto parameters

eter t Value
interfa string 0 to 255 - Interface "10GE1/0/21"

ce_na characters. name.
me
device_ string 0 to 255 - Device name. "CE6850_37.12

name characters. Only one of "
the device
name, device IP
address, and
device MAC
address can
and must be
set.
device_ string 0 to 255 - Device IP "10.6.54.60"

ip characters. address. Only
one of the
device name,
device IP
address, and
device MAC
address can
and must be
set.

iMaster NCE-Fabric

eter t Value
device_ string 0 to 255 - Device MAC "00:50:56:84:7D

mac characters. address. Only :91"
one of the
device name,
device IP
address, and
device MAC
address can
and must be
set.
host string 0 to 255 - Host name. "192.168.62.1"

characters.
Table 1-716 ServiceInfoDto parameters

eter t Value
networ string 0 to 36 - Network ID. "00000000-000

k_id characters. Either vni or 0-0000-1234-0
network must 00000000010"
be set.
vni int32 [1-16000000] - VNI value. 15000

Either vni or
network must
be set.
vlan_id int32 [0-4094] - VLAN ID. 16
Table 1-717 L2brFailReason parameters

eter t Value
id uuid - - L2BR ID. "00000000-000

0-0000-1234-0
00000000004"
error- REFER For details, see Table Error -

info ENCE 1-718. information.

iMaster NCE-Fabric
Table 1-718 ExceptionInfo parameters

eter t Value
error- string 0 to 36 - Error code. "0x00320026"

code characters.
error- string 0 to 1024 - Error message. "Invalid or

msg characters. unavaliable
format"
L2brBatchResponse parameters, For details, see Table 1-713.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"success" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
],
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {
"error-code" : "0x00320026",
"error-msg" : "Invalid or unavaliable format"
}
}
]
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"success" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
],
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {
"error-code" : "0x00320026",
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"success" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
],

iMaster NCE-Fabric
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {
"error-code" : "0x00320026",
}
}
]
}
1.9.5.18.2 Update L2BRs in Batches
Typical Scenarios
L2BRs need to be updated in batches.
Functions
Update L2BRs in batches.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/l2brs/action/batch-update
Request Parameters

l2brBat Yes REFER For details, see L2BR list. -

chReq ENCE Table 1-709.
uest
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/l2brs/action/batch-update HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"l2br" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
]
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"success" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},

iMaster NCE-Fabric
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
],
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {
"error-code" : "0x00320026",
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"success" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
],
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {
"error-code" : "0x00320026",
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"success" : [

iMaster NCE-Fabric
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
],
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {
"error-code" : "0x00320026",
}
}
]
}
1.9.5.18.3 Delete L2BRs in Batches
Typical Scenarios
Delete L2BRs in Batches.
Functions
Delete L2BRs in batches.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/l2brs/action/batch-delete

iMaster NCE-Fabric
Request Parameters

l2brBat Yes REFER For details, see L2BR key value -

chDele ENCE Table 1-721. list.
teRequ
est
Table 1-721 L2brBatchDeleteRequest parameters

l2br Yes ARRAY 0-255 items. For L2BR ID list. -

_REFER details, see
ENCE Table 1-722.
Table 1-722 L2brIdDto parameters

id Yes uuid - - uuid "00000000-000

0-0000-1234-0
00000000002"
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/l2brs/action/batch-delete HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"l2br" : [
{
"id" : "00000000-0000-0000-1234-000000000002"
}
]
}
Response Parameters

iMaster NCE-Fabric
Table 1-723 L2brBatchFailResponse parameters

eter t Value
fail ARRAY 0-255 items. For details, List of failed -

_REFER see Table 1-717. issues.
ENCE
L2brBatchFailResponse parameters, For details, see Table 1-723.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {
"error-code" : "0x00320026",
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {

iMaster NCE-Fabric
"error-code" : "0x00320026",
}
}
]
}
1.9.5.18.4 Create an L2BR
Typical Scenarios
An L2BR needs to be created.
Functions
Create an L2BR.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/l2brs
Request Parameters

l2brDt Yes REFER For details, see Parameters for -

oWrap ENCE Table 1-725. creating an
per L2BR.

iMaster NCE-Fabric
Table 1-725 L2brDtoWrapper parameters


_name 255 name.
charac
ters.
l2br Yes REFER For details, see L2BR object. -

ENCE Table 1-710.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/l2brs HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"l2br" : {
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
}
Response Parameters
Table 1-726 L2brDtoWrapper parameters

eter t Value


iMaster NCE-Fabric

eter t Value
l2br REFER For details, see Table L2BR object. -

ENCE 1-714.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l2br" : {
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.5.18.5 Query All L2BRs
Typical Scenarios
All L2BRs need to be queried.
Functions
Query all L2BRs.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/l2brs


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/l2brs?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-728 L2brQueryOutputDto parameters

eter t Value
l2brs ARRAY 0-255 items. For details, L2BR list. -

ENCE

r ] query entries.

L2brBatchFailResponse parameters, For details, see Table 1-723.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l2brs" : [
{
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}

iMaster NCE-Fabric
}
],
"number" : 1,
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"fail" : [
{
"id" : "00000000-0000-0000-1234-000000000004",
"error-info" : {
"error-code" : "0x00320026",
}
}
]
}
1.9.5.18.6 Query an L2BR by ID
Typical Scenarios
An L2BR needs to be queried by ID.
Functions
Query an L2BR by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/l2brs/{id}

iMaster NCE-Fabric

id Yes uuid - - L2BR ID. "00000000-000

0-0000-1234-0
00000000001"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/l2brs/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
L2brDtoWrapper parameters, For details, see Table 1-726.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l2br" : {
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",

iMaster NCE-Fabric
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.18.7 Update an L2BR by ID
Typical Scenarios
An L2BR policy needs to be updated by name.
Functions
Update an L2BR by name.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes uuid - - L2BR ID. "00000000-000

0-0000-1234-0
00000000001"
Request Parameters

l2brDt Yes REFER For details, see L2BR. -

oWrap ENCE Table 1-725.
per
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/l2brs/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"l2br" : {
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
}
Response Parameters
L2brDtoWrapper parameters, For details, see Table 1-726.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l2br" : {
"id" : "00000000-0000-0000-1234-000000000001",
"name" : "l2br1",
"tenant_id" : "00000000-0000-0000-abce-000000000001",
"device_info" : {
"device_name" : "CE6850_37.12",
"device_ip" : "10.6.54.60",
"device_mac" : "00:50:56:84:7D:91",
"host" : "192.168.62.1"
},
"service_info" : {
"network_id" : "00000000-0000-0000-1234-000000000010",
"vni" : 15000,
"vlan_id" : 16
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.18.8 Delete an L2BR by ID
Typical Scenarios
An L2BR needs to be deleted by ID.

iMaster NCE-Fabric
Functions
Delete an L2BR by ID.
Constraints
HTTP Method
DELETE
URI

id Yes uuid - - L2BR ID. "00000000-000

0-0000-1234-0
00000000001"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/l2brs/00000000-0000-0000-1234-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.19 VpcConnection
# VPC connection operation APIs
1.9.5.19.1 Create a VPC Communication Instance
Typical Scenarios
A VPC connection needs to be created.
Functions
Create a VPC connection.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/controller/dc/v3/servicenetwork/vpc-connects
Request Parameters

vpccon Yes REFER For details, see Input -

nect ENCE Table 1-734. parameter for
creating a VPC
communication
instance.
Table 1-734 VpcConnectDtoWrapper parameters

vpc- Yes ARRAY For details, see VPC connection -

connec _REFER Table 1-735. instance.
t ENCE
totalN No int32 - - Total number 100

um of results.
Table 1-735 VpcConnectDto parameters

id Yes UUID - - VPC "a915f8c1-

communication d06f-46cd-
instance object a968-38328e0a
ID. b2d3"
name Yes string 1 to - VPC connection "vpc001"

255 name.
charac
ters.
descrip No string 0 to - VPC connection "This is vpc"

charac
ters.

iMaster NCE-Fabric

localLo Yes UUID 1 to - Source VPC ID. "a915f8c1-

gicRou 255 d06f-46cd-
terId charac a968-38328e0a
ters. b2d3"
localLo No string 1 to - Source VPC "vpc002"

gicRou 255 name.
terNa charac
me ters.
localLo No UUID 0 to - Logical firewall "a915f8c1-

gicVasI 255 ID of the d06f-46cd-
d charac source VPC. a968-38328e0a
ters. This parameter b2d3"
is optional. If
localFirewallEn
able is set to
true but the
logical firewall
ID is not
specified, the
controller
automatically
searches for or
allocates the
logical firewall
of the source
VPC.
localLo No string 1 to - Logical firewall "vas002"

gicVas 255 name of the
Name charac source VPC.
ters.
localCr No ARRAY For details, see Local -

ossLink _REFER Table 1-736. interconnection
ENCE link
information.
localIn No ARRAY For details, see Local internal -

ternalL _REFER Table 1-737. link
ink ENCE information.
localCi No array< - - Source network -

drs string> segment list.
The value is a
string.

iMaster NCE-Fabric

peerLo Yes UUID 1 to - ID of the "a915f8c1-

gicRou 255 destination d06f-46cd-
terId charac VPC. a968-38328e0a
ters. b2d3"
peerLo No string 1 to - Name of the "router002"

gicRou 255 destination
terNa charac VPC.
me ters.
peerLo No UUID 1 to - Logical firewall "a915f8c1-

d charac destination a968-38328e0a
ters. VPC. This b2d3"
parameter is
optional. If
peerFirewallEn
able is set to
true but the
logical firewall
ID is not
specified, the
controller
automatically
searches for or
allocates the
logical firewall
of the
destination
VPC.
peerLo No string 1 to - Name of the "vas003"

gicVas 255 logical firewall
Name charac for the
ters. destination
VPC.
peerCr No ARRAY For details, see Peer -

ENCE link
information.
peerInt No ARRAY For details, see Peer internal -

ernalLi _REFER Table 1-737. link
nk ENCE information.

iMaster NCE-Fabric

peerCi No array< - - List of -

drs string> destination
network
segments. The
value is a
string.
tenantI No UUID 0 to - Tenant ID. "DBB702C3-77

d 255 19-4FE6-
charac A5AD-3A9C9E2
ters. 6530"
tenant No string 1 to - Name of the "tenant1"

Name 255 tenant to
charac which the local
ters. router belongs.
peerTe No UUID 0 to - Tenant to "a915f8c1-

nantId 255 which the peer d06f-46cd-
charac router belongs. a968-38328e0a
ters. b2d3"
peerTe No string 1 to - Name of the "tenant1"

nantN 255 tenant to
ame charac which the peer
additio No REFER For details, see - -

nal ENCE Table 1-738.
localFir No boolea - false Whether the false

ewallE n firewall is
nable enabled on the
source VPC. It
is disabled by
default.
peerFir No boolea - false Whether the true

ewallE n destination
nable VPC is
protected by a
firewall. By
default, this
function is
disabled.

iMaster NCE-Fabric

isLocal No boolea - false Whether to false

All n enable
dynamic
routing on the
local end in the
MDC scenario.
isPeer No boolea - false Whether to true

All n enable
dynamic
routing on the
peer end in the
MDC scenario.
priority No int32 - - Priority of a 60

static route.
localPr No int32 - - Local 50

eferenc preference of
e BGP routes in a
routing policy.
dciGat No array< 0-2147 - DCI gateway -

ewayId string> 48364 device group
s 7 ID.
items.
connec No string 0 to - Route target "1:3,65537:3,0.

tRt 255 for VPC 0:3,192.168.122
charac communication .15:1."
ters. .
srcGw No array< 0-2147 - ID list of source -

DeviceI string> 48364 egress
ds 7 gateways for
items. VPC
communication
.
dstGw No array< 0-2147 - ID list of -

DeviceI string> 48364 destination
ds 7 egress
items. gateways for
VPC
communication
.

iMaster NCE-Fabric

localR No string 1 to - Type of the "LogicRouter/

outerT 255 local router. ExternalTransit
ype charac Router/
ters. ExternalGatew
ay"
peerRo No string 1 to - Type of the "LogicRouter/

uterTy 255 peer router. ExternalTransit
pe charac Router/
ters. ExternalGatew
ay"
isAssoc No boolea - true Whether to true

iatedV n modify the VPC
pcCon interworking
nPolicy policy.
Table 1-736 CrossLinkParam parameters

routerI No string 0 to - Interconnection "10.1.1.1"

p 255 IP address on a
charac router.
ters.
vasIp No string 0 to - Interconnection "10.1.1.1"

255 IP address on
charac the logical VAS
ters. device.
vlan No string 0 to 64 - Interconnection "100"

charac VLAN.
ters.
routerI No string 0 to - IPv6 "FE80:0000:000

pv6 255 interconnection 0:0000:0000:00
charac address on a 44:0000:0032"
ters. router.
vasIpv No string 0 to - IPv6 "FE80:0000:000

6 255 interconnection 0:0000:0000:00
ters. VAS device.

iMaster NCE-Fabric

fabricI No string 0 to 36 - Unique ID of a "DBB702C3-77

d charac fabric. 19-4FE6-4488-
ters. 3A9C9E265322
"
Table 1-737 InternalLinkParam parameters

routerI No string 0 to - IP address of "10.1.1.1"

p 255 the router.
charac
ters.
vasIp No string 0 to - IP address of "10.1.1.1"

255 the logical VAS
charac device.
ters.
vlan No string 0 to 64 - VLAN. "100"

charac
ters.
routerI No string 0 to - IPv6 address of "FE80:0000:000

pv6 255 the router. 0:0000:0000:00
charac 44:0000:0032"
ters.
vasIpv No string 0 to - IPv6 address of "FE80:0000:000

6 255 the logical VAS 0:0000:0000:00
charac device. 44:0000:0032"
ters.
Table 1-738 AdditionalDto parameters

produc No string 0 to 36 - Parameters for "CloudPlatform

er charac configuring a 1"
ters. condition.

At 255 0:11:16.000+00:
charac 00"
ters.

iMaster NCE-Fabric


At 255 0:11:16.000+00:
charac 00"
ters.
Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/vpc-connects HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
"description" : "This is vpc",
"localLogicRouterId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"localLogicRouterName" : "vpc002",
"localLogicVasId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"localLogicVasName" : "vas002",
"localCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"fabricId" : "DBB702C3-7719-4FE6-4488-3A9C9E265322"
}
],
"localInternalLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerLogicRouterId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"peerLogicRouterName" : "router002",
"peerLogicVasId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"peerLogicVasName" : "vas003",
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}

iMaster NCE-Fabric
],
"peerInternalLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],
"tenantName" : "tenant1",
"peerTenantId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"peerTenantName" : "tenant1",
"additional" : {
"producer" : "CloudPlatform1",
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
},
"localFirewallEnable" : false,
"peerFirewallEnable" : true,
"isLocalAll" : false,
"isPeerAll" : true,
"priority" : 60,
"localPreference" : 50,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"srcGwDeviceIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"dstGwDeviceIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"localRouterType" : "LogicRouter/ExternalTransitRouter/ExternalGateway",
"peerRouterType" : "LogicRouter/ExternalTransitRouter/ExternalGateway",
"isAssociatedVpcConnPolicy" : true
}
],
"totalNum" : 100
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.19.2 Query VPC Connections
Typical Scenarios
Use this API to query the VPC communication instance list.
Functions
This API is used to query the VPC communication instance list based on the
producer or the tenant ID.
Constraints
HTTP Method
GET
URI


ters. condition.
isTrans No boolea - false Whether to -

it n query all
transit VPC
connections.

iMaster NCE-Fabric

tenantI No UUID - - ID of the "a915f8c1-

d tenant to d06f-46cd-
which the SFC a968-38328e0a
template b2d3"
belongs.
pageIn No string - - Page index. "1"

dex

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vpc-connects?producer=CloudPlatform1&tenantId=a915f8c1-
d06f-46cd-a968-38328e0ab2d3&pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

eter t Value
vpc- ARRAY For details, see Table VPC connection -

connec _REFER 1-741. instance.
t ENCE

um of results.

iMaster NCE-Fabric

eter t Value
id UUID - - VPC "a915f8c1-

ID. b2d3"
name string 1 to 255 - VPC connection "vpc001"

characters. name.
descrip string 0 to 255 - VPC connection "This is vpc"

localLo UUID 1 to 255 - Source VPC ID. "a915f8c1-

gicRou characters. d06f-46cd-
terId a968-38328e0a
b2d3"
localLo string 1 to 255 - Source VPC "vpc002"

gicRou characters. name.
terNa
me
localLo UUID 0 to 255 - Logical firewall "a915f8c1-

gicVasI characters. ID of the d06f-46cd-
d source VPC. a968-38328e0a
This parameter b2d3"
is optional. If
localFirewallEn
able is set to
true but the
logical firewall
ID is not
specified, the
controller
automatically
searches for or
allocates the
logical firewall
of the source
VPC.
localLo string 1 to 255 - Logical firewall "vas002"

gicVas characters. name of the
Name source VPC.
localCr ARRAY For details, see Table Local -

ossLink _REFER 1-742. interconnection
ENCE link
information.

iMaster NCE-Fabric

eter t Value
localIn ARRAY For details, see Table Local internal -

ternalL _REFER 1-743. link
localCi array< - - Source network -

The value is a
string.
peerLo UUID 1 to 255 - ID of the "a915f8c1-

gicRou characters. destination d06f-46cd-
terId VPC. a968-38328e0a
b2d3"
peerLo string 1 to 255 - Name of the "router002"

gicRou characters. destination
terNa VPC.
me
peerLo UUID 1 to 250 - Logical firewall "a915f8c1-

d destination a968-38328e0a
VPC. This b2d3"
parameter is
optional. If
peerFirewallEn
able is set to
true but the
logical firewall
ID is not
specified, the
controller
automatically
searches for or
allocates the
logical firewall
of the
destination
VPC.
peerLo string 1 to 255 - Name of the "vas003"

gicVas characters. logical firewall
Name for the
destination
VPC.
peerCr ARRAY For details, see Table Peer -

ENCE link
information.

iMaster NCE-Fabric

eter t Value
peerInt ARRAY For details, see Table Peer internal -

ernalLi _REFER 1-743. link
peerCi array< - - List of -

network
segments. The
value is a
string.
tenantI UUID 0 to 255 - Tenant ID. "DBB702C3-77

A5AD-3A9C9E2
6530"
tenant string 1 to 255 - Name of the "tenant1"

Name characters. tenant to
which the local
router belongs.
peerTe UUID 0 to 255 - Tenant to "a915f8c1-

nantId characters. which the peer d06f-46cd-
router belongs. a968-38328e0a
b2d3"
peerTe string 1 to 255 - Name of the "tenant1"

nantN characters. tenant to
ame which the peer
router belongs.
additio REFER For details, see Table - -

nal ENCE 1-744.
localFir boolea - false Whether the false

source VPC. It
is disabled by
default.
peerFir boolea - false Whether the true

nable VPC is
protected by a
firewall. By
default, this
function is
disabled.

iMaster NCE-Fabric

eter t Value
isLocal boolea - false Whether to false

All n enable
dynamic
routing on the
local end in the
MDC scenario.
isPeer boolea - false Whether to true

All n enable
dynamic
routing on the
peer end in the
MDC scenario.
priority int32 - - Priority of a 60

static route.
localPr int32 - - Local 50

e BGP routes in a
routing policy.
dciGat array< 0-2147483647 - DCI gateway -

ewayId string> items. device group
s ID.
connec string 0 to 255 - Route target "1:3,65537:3,0.

tRt characters. for VPC 0:3,192.168.122
communication .15:1."
.
srcGw array< 0-2147483647 - ID list of source -

DeviceI string> items. egress
ds gateways for
VPC
communication
.
dstGw array< 0-2147483647 - ID list of -

DeviceI string> items. destination
ds egress
gateways for
VPC
communication
.

iMaster NCE-Fabric

eter t Value
localR string 1 to 255 - Type of the "LogicRouter/

outerT characters. local router. ExternalTransit
ype Router/
ExternalGatew
ay"
peerRo string 1 to 255 - Type of the "LogicRouter/

uterTy characters. peer router. ExternalTransit
pe Router/
ExternalGatew
ay"
isAssoc boolea - true Whether to true

pcCon interworking
nPolicy policy.

eter t Value
routerI string 0 to 255 - Interconnection "10.1.1.1"

p characters. IP address on a
router.
vasIp string 0 to 255 - Interconnection "10.1.1.1"

characters. IP address on
the logical VAS
device.
vlan string 0 to 64 - Interconnection "100"

characters. VLAN.
routerI string 0 to 255 - IPv6 "FE80:0000:000

pv6 characters. interconnection 0:0000:0000:00
address on a 44:0000:0032"
router.
vasIpv string 0 to 255 - IPv6 "FE80:0000:000

6 characters. interconnection 0:0000:0000:00
address on a 44:0000:0032"
VAS device.
fabricI string 0 to 36 - Unique ID of a "DBB702C3-77

d characters. fabric. 19-4FE6-4488-
3A9C9E265322
"

iMaster NCE-Fabric

eter t Value
routerI string 0 to 255 - IP address of "10.1.1.1"

p characters. the router.
vasIp string 0 to 255 - IP address of "10.1.1.1"

characters. the logical VAS
device.
vlan string 0 to 64 - VLAN. "100"

characters.
routerI string 0 to 255 - IPv6 address of "FE80:0000:000

pv6 characters. the router. 0:0000:0000:00
44:0000:0032"
vasIpv string 0 to 255 - IPv6 address of "FE80:0000:000

6 characters. the logical VAS 0:0000:0000:00
device. 44:0000:0032"

eter t Value
produc string 0 to 36 - Parameters for "CloudPlatform

er characters. configuring a 1"
condition.

00"

00"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"

iMaster NCE-Fabric
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
}
],
"totalNum" : 100
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.19.3 Query a VPC Communication Instance
Typical Scenarios
Use this API to query a VPC communication instance.
Functions
Query a VPC connection by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/vpc-connects/vpc-connect/{id}

iMaster NCE-Fabric


ID. b2d3"
Request Parameters

dtId No string 0 to - distribution "G2021110115

256 transaction ID. 2812691_b34d
charac 98a-57f9-49b2
ters. -910c-010bcfcc
97bcd"
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vpc-connects/vpc-connect/a915f8c1-d06f-46cd-a968-38328e0ab2d3
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
dtId: "G20211101152812691_b34d98a-57f9-49b2-910c-010bcfcc97bcd"
Response Parameters
VpcConnectDtoWrapper parameters, For details, see Table 1-740.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],

iMaster NCE-Fabric
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
}
],
"totalNum" : 100
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.19.4 Update a VPC Communication Instance
Typical Scenarios
A VPC connection needs to be updated by ID.
Functions
Update a VPC connection by ID.
Constraints
HTTP Method
PUT

iMaster NCE-Fabric
URI


ID. b2d3"
Request Parameters


creating a VPC
communication
instance.
Sample Request
HTTP
PUT /controller/dc/v3/servicenetwork/vpc-connects/vpc-connect/a915f8c1-d06f-46cd-a968-38328e0ab2d3
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",

iMaster NCE-Fabric
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],

iMaster NCE-Fabric
}
],
"totalNum" : 100
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",

iMaster NCE-Fabric
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
}
],
"totalNum" : 100
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.19.5 Delete a VPC Communication Instance
Typical Scenarios
A VPC connection needs to be deleted by ID.

iMaster NCE-Fabric
Functions
Delete a VPC connection by ID.
Constraints
HTTP Method
DELETE
URI


ID. b2d3"

produc No string - - Provider. "Agile-

er Controller-
MDC"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/servicenetwork/vpc-connects/vpc-connect/a915f8c1-d06f-46cd-
a968-38328e0ab2d3?producer=Agile-Controller-MDC HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.20 L2 DC/POD Interconnection

# Layer 2 DC/POD interconnection operation APIs
1.9.5.20.1 Create a Layer 2 DC/POD Interconnection Instance
Typical Scenarios
Create a Layer 2 DC/POD Interconnection Instance.
Functions
Create a Layer 2 DC/POD interconnection instance.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/controller/dc/v2/neutronapi/v2.0/l2-dci-connects
Request Parameters

dciL2C Yes REFER For details, see Parameters for -

onnect ENCE Table 1-752. creating a
DtoWr Layer 2
apper DC/POD
interconnection
instance.
Table 1-752 DciL2ConnectDtoWrapper parameters

service No string 0 to - Cloud platform "physnet1"

_name 255 name.
charac
ters.
l2-dci- Yes REFER For details, see Layer 2 DCI -

connec ENCE Table 1-753. connection
t object.
Table 1-753 DciL2Dto parameters

id Yes string 0 to - Layer 2 DCI "DBB702C3-77

256 instance ID. 19-4FE6-
updated.
name Yes string 0 to - Layer 2 DCI "nameofDciL2"

255 instance name.
charac This field
ters. cannot be
updated.

iMaster NCE-Fabric

descrip No string 0 to - Layer 2 DCI "L2 Dci object

tion 1024 instance description"
charac description.
ters.
networ Yes string 0 to - Local logical "DBB702C3-77

k_id 256 switch. This 19-4FE6-
charac field cannot be A5AD-3A9C9E2
vni Yes int32 [1-160 - Layer 2 100

00000] DC/POD
interconnection
mapping VNI.
export Yes array< 0-255 - Export RT of ["1:1"]

_rts string> items. the EVPN for
Each Layer 2
item DC/POD
has 0 interconnection
to 255 .
charac
ters.
import Yes array< 0-255 - Import RT of ["1:1"]

_rts string> items. the EVPN for
Each Layer 2
item DC/POD
has 0 interconnection
to 255 .
charac
ters.
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/v2.0/l2-dci-connects HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"l2-dci-connect" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "nameofDciL2",
"description" : "L2 Dci object description",
"vni" : 100,
"export_rts" : ["1:1"],

iMaster NCE-Fabric
"import_rts" : ["1:1"]
}
}
Response Parameters

eter t Value

l2-dci- REFER For details, see Table Layer 2 DCI -

connec ENCE 1-755. connection
t object.

eter t Value
id string 0 to 256 - Layer 2 DCI "DBB702C3-77

characters. instance ID. 19-4FE6-
cannot be 65309"
updated.
name string 0 to 255 - Layer 2 DCI "nameofDciL2"

characters. instance name.
This field
cannot be
updated.
descrip string 0 to 1024 - Layer 2 DCI "L2 Dci object

tion characters. instance description"
description.
networ string 0 to 256 - Local logical "DBB702C3-77

k_id characters. switch. This 19-4FE6-
field cannot be A5AD-3A9C9E2
updated. 65310"
vni int32 [1-16000000] - Layer 2 100

DC/POD
interconnection
mapping VNI.

iMaster NCE-Fabric

eter t Value
export array< 0-255 items. - Export RT of ["1:1"]

_rts string> Each item has 0 the EVPN for
to 255 Layer 2
characters. DC/POD
interconnection
.
import array< 0-255 items. - Import RT of ["1:1"]

_rts string> Each item has 0 the EVPN for
to 255 Layer 2
characters. DC/POD
interconnection
.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vni" : 100,
"export_rts" : ["1:1"],
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.20.2 L2 DC/POD Interconnection
Typical Scenarios
All Layer 2 DC/POD interconnection instances need to be queried.
Functions
Query all Layer 2 DC/POD interconnection instances.
Constraints
HTTP Method
GET
URI


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /controller/dc/v2/neutronapi/v2.0/l2-dci-connects?pageIndex=1&pageSize=10 HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-757 DciL2QueryOutputDto parameters

eter t Value
l2-dci- ARRAY 0-255 items. For details, Layer 2 DCI -

connec _REFER see Table 1-755. connection
ts ENCE object.

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l2-dci-connects" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vni" : 100,
"export_rts" : ["1:1"],
}
],
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.20.3 Query a Layer 2 DC/POD Interconnection Instance by ID
Typical Scenarios
A Layer 2 DC/POD interconnection instance needs to be queried by ID.
Functions
Query a Layer 2 DC/POD interconnection instance.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/neutronapi/v2.0/l2-dci-connects/{id}

id Yes string 0 to - Parameters for "DBB702C3-77

256 querying a 19-4FE6-
charac Layer 2 A5AD-3A9C9E2
ters. DC/POD 60001"
interconnection
instance.

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/v2.0/l2-dci-connects/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
DciL2ConnectDtoWrapper parameters, For details, see Table 1-754.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vni" : 100,
"export_rts" : ["1:1"],
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.20.4 Update a Layer 2 DC/POD Interconnection Instance
Typical Scenarios
A Layer 2 DC/POD interconnection instance needs to be updated.
Functions
Update a Layer 2 DC/POD interconnection instance.
Constraints
HTTP Method
PUT
URI


256 a Layer 2 19-4FE6-
charac DC/POD A5AD-3A9C9E2
ters. interconnection 60001"
instance.

iMaster NCE-Fabric
Request Parameters

router Yes REFER For details, see Parameters for -

DtoWr ENCE Table 1-752. updating a
apper Layer 2
DC/POD
interconnection
instance.
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/v2.0/l2-dci-connects/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vni" : 100,
"export_rts" : ["1:1"],
}
}
Response Parameters
Sample Response

iMaster NCE-Fabric
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vni" : 100,
"export_rts" : ["1:1"],
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.20.5 Delete a Router DCI
Typical Scenarios
A Layer 2 DC/POD interconnection instance needs to be deleted.
Functions
Delete a Layer 2 DC/POD interconnection instance.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric

id Yes string 0 to - Parameters for "DBB702C3-77

256 deleting a 19-4FE6-
charac Layer 2 A5AD-3A9C9E2
ters. DC/POD 60001"
interconnection
instance.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/v2.0/l2-dci-connects/DBB702C3-7719-4FE6-A5AD-3A9C9E260001
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.21 DCI L3
1.9.5.21.1 L3 DC/POD Interconnection

# Layer 3 DC/POD interconnection operation APIs
Create a Layer 3 DC/POD Interconnection Instance
Typical Scenarios
A Layer 3 DC/POD interconnection instance needs to be created.
Functions
Create a Layer 3 DC/POD interconnection instance.
Constraints
HTTP Method
POST
URI

iMaster NCE-Fabric
Request Parameters


Layer 3
DC/POD
interconnection
instance.


_name 255 name.
charac
ters.
l3-dci- Yes REFER For details, see Layer 3 DCI -

connec ENCE Table 1-764. object.
t

iMaster NCE-Fabric

id Yes string 36 - L3DCI ID. This "DBB702C3-77

The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name Yes string 0 to - L3DCI name. "nameofDciL3"

255 This field
charac cannot be
ters. updated.
descrip No string 0 to - L3DCI "L3 Dci object

charac
ters.
router_ Yes string 0 to 36 - Local logical "DBB702C3-77

id charac router ID. This 19-4FE6-
ters. field cannot be A5AD-3A9C9E2
updated. 65310"

iMaster NCE-Fabric

fw_ena Yes boolea - - Whether to false

ble n enable the
firewall. This
field cannot be
updated.
logic_f No string 0 to 36 - Logical firewall "DBB702C3-77

w_id charac bound to a 19-4FE6-
ters. logical router A5AD-3A9C9E2
for DCI. 65311"
local_s Yes array< 0-255 - List of subnets ["DBB702C3-7

ubnets string> items. that can be 719-4FE6-
interconnected A5AD-3A9C9E2
across DCs on 55300"]
the local
router.
peer_ci No array< 0-255 - Remote CIDRs ["10.1.0.0/16"]

drs string> items. that can be
accessed across
DCs. This
parameter is
available only
when the
firewall is
enabled.
import Yes array< 0-255 - Import RT of ["1:1"]

_rts string> items. the BGP EVPN
for L3DCI.
export Yes array< 0-255 - Export RT of ["1:1"]

_rts string> items. the BGP EVPN
for L3DCI.
data_ No int32 [0-255 - Packet 1

mode ] encapsulation
type. The value
1 indicates
VXLAN, and
the value 2
indicates MPLS.
The packet
encapsulation
type can be
extended.

iMaster NCE-Fabric

l3_vni No int32 [1-160 - L3VNI for DCI. 1

00000]
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/v2.0/l3-dci-connects HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"router_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265310",
"fw_enable" : false,
"logic_fw_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265311",
"local_subnets" : ["DBB702C3-7719-4FE6-A5AD-3A9C9E255300"],
"peer_cidrs" : ["10.1.0.0/16"],
"import_rts" : ["1:1"],
"export_rts" : ["1:1"],
"data_mode" : 1,
"l3_vni" : 1
}
}
Response Parameters

eter t Value

l3-dci- REFER For details, see Table Layer 3 DCI -

connec ENCE 1-766. object.
t

iMaster NCE-Fabric

eter t Value
id string 36 characters. - L3DCI ID. This "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 0 to 255 - L3DCI name. "nameofDciL3"

characters. This field
cannot be
updated.
descrip string 0 to 1024 - L3DCI "L3 Dci object

router_ string 0 to 36 - Local logical "DBB702C3-77

id characters. router ID. This 19-4FE6-
field cannot be A5AD-3A9C9E2
updated. 65310"
fw_ena boolea - - Whether to false

ble n enable the
firewall. This
field cannot be
updated.
logic_f string 0 to 36 - Logical firewall "DBB702C3-77

w_id characters. bound to a 19-4FE6-
logical router A5AD-3A9C9E2
for DCI. 65311"
local_s array< 0-255 items. - List of subnets ["DBB702C3-7

ubnets string> that can be 719-4FE6-
interconnected A5AD-3A9C9E2
across DCs on 55300"]
the local
router.

iMaster NCE-Fabric

eter t Value
peer_ci array< 0-255 items. - Remote CIDRs ["10.1.0.0/16"]

drs string> that can be
accessed across
DCs. This
parameter is
available only
when the
firewall is
enabled.
import array< 0-255 items. - Import RT of ["1:1"]

_rts string> the BGP EVPN
for L3DCI.

_rts string> the BGP EVPN
for L3DCI.
data_ int32 [0-255] - Packet 1

mode encapsulation
type. The value
1 indicates
VXLAN, and
the value 2
indicates MPLS.
The packet
encapsulation
type can be
extended.
l3_vni int32 [1-16000000] - L3VNI for DCI. 1
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peer_cidrs" : ["10.1.0.0/16"],
"import_rts" : ["1:1"],
"export_rts" : ["1:1"],
"data_mode" : 1,
"l3_vni" : 1
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
L3 DC/POD Interconnection
Typical Scenarios
All Layer 3 DC/POD interconnection instances need to be queried.
Functions
Query all Layer 3 DC/POD interconnection instances.
Constraints
HTTP Method
GET
URI

iMaster NCE-Fabric


dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/v2.0/l3-dci-connects?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-768 DciL3QueryOutputDto parameters

eter t Value
l3-dci- ARRAY 0-255 items. For details, List of Layer 3 -

connec _REFER see Table 1-766. DCI objects.
ts ENCE


iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l3-dci-connects" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peer_cidrs" : ["10.1.0.0/16"],
"import_rts" : ["1:1"],
"export_rts" : ["1:1"],
"data_mode" : 1,
"l3_vni" : 1
}
],
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Query a Layer 3 DC/POD Interconnection Instance by ID
Typical Scenarios
A Layer 3 DC/POD interconnection instance needs to be queried by ID.
Functions
Query a Layer 3 DC/POD interconnection instance by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI


charac querying a 19-4FE6-
ters. Layer 3 A5AD-3A9C9E2
The DC/POD 60001"
value interconnection
must instance.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /controller/dc/v2/neutronapi/v2.0/l3-dci-connects/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/

1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peer_cidrs" : ["10.1.0.0/16"],
"import_rts" : ["1:1"],
"export_rts" : ["1:1"],
"data_mode" : 1,
"l3_vni" : 1
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Update a Layer 3 DC/POD Interconnection Instance by ID
Typical Scenarios
A Layer 3 DC/POD interconnection instance needs to be updated by ID.
Functions
Update a Layer 3 DC/POD interconnection instance by ID.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric


charac updating a 19-4FE6-
The DC/POD 60001"
must instance.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

router Yes REFER For details, see Parameters for -

DtoWr ENCE Table 1-763. updating a
apper Layer 3
DC/POD
interconnection
instance.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/v2.0/l3-dci-connects/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peer_cidrs" : ["10.1.0.0/16"],
"import_rts" : ["1:1"],
"export_rts" : ["1:1"],
"data_mode" : 1,
"l3_vni" : 1
}
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peer_cidrs" : ["10.1.0.0/16"],

iMaster NCE-Fabric
"import_rts" : ["1:1"],
"export_rts" : ["1:1"],
"data_mode" : 1,
"l3_vni" : 1
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Delete a Router DCI
Typical Scenarios
A Layer 3 DC/POD interconnection instance needs to be deleted by ID.
Functions
Delete a Layer 3 DC/POD interconnection instance by ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric


charac deleting a 19-4FE6-
The DC/POD 60001"
must instance.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/neutronapi/v2.0/l3-dci-connects/DBB702C3-7719-4FE6-A5AD-3A9C9E260001
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.21.2 L3Dci Subnet

# Operation API for adding a L3DCI subnet
Create an L3DCI Subnet
Typical Scenarios
An L3DCI subnet needs to be created.
Functions
Create an L3DCI subnet.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/v2.0/l3-add-dci-subnet

iMaster NCE-Fabric
Request Parameters

dciL3A Yes REFER For details, see Parameters for -

ddSub ENCE Table 1-774. creating an
netDto L3DCI subnet.
Wrapp
er
Table 1-774 DciL3AddSubnetDtoWrapper parameters


_name 255 name.
charac
ters.
l3- Yes REFER For details, see - -

add- ENCE Table 1-775.
dci-
subnet
Table 1-775 DciL3AddSubnetDto parameters

id Yes uuid - - L3DCI instance "DBB702C3-77

ID. 19-4FE6-
A5AD-3A9C9E2
65308"
router_ Yes uuid - - Local logical "DBB702C3-77

id router. 19-4FE6-
A5AD-3A9C9E2
65309"
subnet Yes uuid - - Local "DBB702C3-77

_id interconnection 19-4FE6-
subnet ID to be A5AD-3A9C9E2
added. 65310"

iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/v2.0/l3-add-dci-subnet HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"l3-add-dci-subnet" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265308",
}
}
Response Parameters
Table 1-776 DciL3AddSubnetDtoWrapper parameters

eter t Value

l3- REFER For details, see Table - -

add- ENCE 1-777.
dci-
subnet
Table 1-777 DciL3AddSubnetDto parameters

eter t Value
id uuid - - L3DCI instance "DBB702C3-77

ID. 19-4FE6-
A5AD-3A9C9E2
65308"
router_ uuid - - Local logical "DBB702C3-77

id router. 19-4FE6-
A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
subnet uuid - - Local "DBB702C3-77

added. 65310"
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l3-add-dci-subnet" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265308",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.21.3 Delete L3 Dci Subnet

# L3DCI subnet deletion API

iMaster NCE-Fabric
Delete an L3DCI Subnet
Typical Scenarios
An L3DCI subnet needs to be deleted.
Functions
Delete an L3DCI subnet.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/neutronapi/v2.0/l3-del-dci-subnet
Request Parameters

dciL3D Yes REFER For details, see Parameters for -

elSubn ENCE Table 1-779. deleting an
etDto L3DCI subnet.
Wrapp
er
Table 1-779 DciL3DelSubnetDtoWrapper parameters


_name 255 name.
charac
ters.

iMaster NCE-Fabric

l3-del- Yes REFER For details, see - -

dci- ENCE Table 1-780.
subnet
Table 1-780 DciL3DelSubnetDto parameters

id Yes uuid - - L3DCI instance "DBB702C3-77

ID. 19-4FE6-
A5AD-3A9C9E2
65308"
router_ Yes uuid - - Local logical "DBB702C3-77

id router. 19-4FE6-
A5AD-3A9C9E2
65309"
subnet Yes uuid - - Local "DBB702C3-77

added. 65310"
Sample Request
HTTP
POST /controller/dc/v2/neutronapi/v2.0/l3-del-dci-subnet HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"l3-del-dci-subnet" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265308",
}
}
Response Parameters

iMaster NCE-Fabric
Table 1-781 DciL3DelSubnetDtoWrapper parameters

eter t Value

l3-del- REFER For details, see Table - -

dci- ENCE 1-782.
subnet
Table 1-782 DciL3DelSubnetDto parameters

eter t Value
id uuid - - L3DCI instance "DBB702C3-77

ID. 19-4FE6-
A5AD-3A9C9E2
65308"
router_ uuid - - Local logical "DBB702C3-77

id router. 19-4FE6-
A5AD-3A9C9E2
65309"
subnet uuid - - Local "DBB702C3-77

added. 65310"
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"l3-del-dci-subnet" : {

iMaster NCE-Fabric
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265308",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.22 Heartbeat Connectivity of the Cloud Platform

# Interface SLA
| Feature | Indicator |
|---|---|
| Interface | Query interface SLA |
| Request success rate | ≥ 99% |
| Availability | Tier1 |
| Consistency | Strong consistency |
| Throughput | 200 TPS |
| TP50 request delay | 50 ms |
| TP99.9 request delay | 100 ms |
1.9.5.22.1 Detect Heartbeats Between the Cloud Platform and the Controller
Typical Scenarios
The availability of the northbound connection between the cloud platform and
controller needs to be checked.
Functions
Maintain the heartbeat of the northbound connection between the cloud platform
and controller.
Constraints

iMaster NCE-Fabric

HTTP Method
PUT
URI
/controller/dc/v2/neutronapi/cloud/northheartbeat
Request Parameters

cloudN Yes REFER For details, see The cloud -

orthHe ENCE Table 1-784. platform needs
artBea to detect
tDtoW whether the
rapper northbound
interface of the
controller is
available.
Table 1-784 CloudNorthHeartBeatWrapper parameters

cloud_ Yes string 0 to - Cloud platform "physnet1"

name 255 name.
charac
ters.
agent_ Yes string 0 to - IP address of "192.168.3.2"

ip 255 the cloud
charac platform node
ters. that detects
heartbeats.
Sample Request
HTTP
PUT /controller/dc/v2/neutronapi/cloud/northheartbeat HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"cloud_name" : "physnet1",
"agent_ip" : "192.168.3.2"
}
Response Parameters
Table 1-785 CloudNorthHeartBeatWrapper parameters

eter t Value
cloud_ string 0 to 255 - Cloud platform "physnet1"

agent_ string 0 to 255 - IP address of "192.168.3.2"

ip characters. the cloud
platform node
that detects
heartbeats.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"cloud_name" : "physnet1",
"agent_ip" : "192.168.3.2"
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.5.23 Neutron Routing Whitelist

Routing whitelist API description:
1. Create a routing whitelist.
2. Query routing whitelist information by ID.
3. Update routing whitelist information by ID.
4. Delete routing whitelist information by ID.
SLAs for query interfaces
Throughput: 200 TPS
1.9.5.23.1 Query Routing Whitelist Information
Typical Scenarios
Routing whitelists need to be queried.
Functions
Query routing whitelist information by router ID.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v2/neutronapi/logicnetwork/external_whitelists/{id}

id Yes string 36 - Routing "DBB702C3-77

charac whitelist ID. 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/neutronapi/logicnetwork/external_whitelists/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-787 RouteWhiteListWrapper parameters

eter t Value
extern REFER For details, see Table Whitelist -

al_whit ENCE 1-788. parameter.
elist
Table 1-788 WhiteListDtoWrapper parameters

eter t Value
id string 36 characters. - Route whitelist "00000000-000

meet the 00000000002"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
router_ string 36 characters. - Router ID. "00000000-000

id The value must 0-0000-1234-0
meet the 00000000002"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
routes array< 0-500 items. - Route IP -

string> Each item has 0 address.
to 50
characters.
subnet array< 0-500 items. - Subnet ID. -

s string> Each item has
36 characters.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"external_whitelist" : {
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6 K8S
1.9.6.1 Container Platform

Third-party northbound APIs for managing the container platform
1.9.6.1.1 Query All Container Platforms
Typical Scenarios
All container platforms need to be queried.
Functions
Query the container platform list.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v2/containerplatform/k8s


dex number.

ze
name No string - - Fuzzy match of "kk"

container
platform
names.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/k8s?pageIndex=1&pageSize=10&name=kk HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-790 K8sQueryListDtoWrapper parameters

eter t Value
k8s ARRAY For details, see Table Container -

_REFER 1-791. platform list.
ENCE
total- int32 - - Total number 10

num of K8S nodes.

iMaster NCE-Fabric
Table 1-791 K8sQueryDto parameters

eter t Value
id string 36 characters. - Container "00000000-000

The value must platform ID. 0-0000-0000-0
meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 128 - Container "k8s_dev"

characters. platform name.
tenant string 1 to 255 - Tenant name. "tenant"

-name characters.
agent ARRAY For details, see Table Agent object. -

_REFER 1-792.
ENCE
multi- boolea - - Whether multi- false

tenant n tenant is used.
reuse- ARRAY For details, see Table Reused data -

datas _REFER 1-793. list.
ENCE
related array< Each item has - List of -

-fabric string> 36 characters. associated
fabric IDs.
status string 1 to 32 - K8S status. -

characters.
monito int32 - - Listening port. 11111

r-port
net- string - - Network mode "L2"

mode of the
container
platform,
which can be
L2, L3, or L2L3.
related ARRAY For details, see Table Associated -

-datas _REFER 1-794. data list.
ENCE

iMaster NCE-Fabric

eter t Value
device- string - - Loopback IPv6 -

loopba address of the
ck- device.
ipv6-
ipaddr
ess
device- string - - Loopback IPv4 "192.168.13.2"

ck- device.
ipv4-
ipaddr
ess
cni- string - - CNI mode of -

type the container
network, which
can be Hwcni
or Calico.
tenant ARRAY For details, see Table Tenant list. -

-list _REFER 1-795.
ENCE
Table 1-792 agent parameters

eter t Value
status string ● online - The connection -

● offline status.
ipv4- string - - IP address of "192.168.10.2"

addres the K8s
s monitor.

iMaster NCE-Fabric
Table 1-793 ReuseDataDto parameters

eter t Value
tenant string 36 characters. - Multiplexed "00000000-000

-id The value must Layer 2/Layer 3 0-0000-0000-0
meet the tenant ID 00000000004"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
router- string 36 characters. - Multiplexed "00000000-000

id The value must Layer 2/Layer 3 0-0000-0000-0
meet the logical router 00000000004"
following ID
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Table 1-794 RelatedDataDto parameters

eter t Value
tenant string 36 characters. - Multiplexed "00000000-000

-id The value must Layer 2/Layer 3 0-0000-0000-0
meet the tenant ID 00000000004"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
router- string 36 characters. - Multiplexed "00000000-000

id The value must Layer 2/Layer 3 0-0000-0000-0
meet the logical router 00000000004"
following ID
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

eter t Value
id string 36 characters. - Tenant ID. "00000000-000

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - Tenant name. "tenant_name"

characters.
l23_te string 36 characters. - Layer 2 or "00000000-000

nant_i The value must Layer 3 tenant 0-0000-0000-0
d meet the ID. 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"k8s" : [
{
"id" : "00000000-0000-0000-0000-000000000001",
"name" : "k8s_dev",
"tenant-name" : "tenant",
"agent" : [
{
"ipv4-address" : "192.168.10.2"
}
],
"multi-tenant" : false,
"reuse-datas" : [
{
"tenant-id" : "00000000-0000-0000-0000-000000000004",
"router-id" : "00000000-0000-0000-0000-000000000004"
}
],
"related-fabric" : [
"6eaa2006-0eb2-4395-90d9-e351310a8e2d"
],
"monitor-port" : 11111,
"net-mode" : "L2",
"related-datas" : [
{
"tenant-id" : "00000000-0000-0000-0000-000000000004",
"router-id" : "00000000-0000-0000-0000-000000000004"
}
],
"device-loopback-ipv4-ipaddress" : "192.168.13.2",
"tenant-list" : [
{
"id" : "00000000-0000-0000-0000-000000000001",
"name" : "tenant_name",
"l23_tenant_id" : "00000000-0000-0000-0000-000000000001"
}
]
}
],
"total-num" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.1.2 Query a Container Platform by ID
Typical Scenarios
A container platform needs to be queried by ID.
Functions
Query a container platform based on the ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/k8s/{id}

iMaster NCE-Fabric

id Yes string 36 - Container "00000000-000

charac platform ID. 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/k8s/00000000-0000-0000-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-797 K8sQueryDtoWrapper parameters

eter t Value
k8s REFER For details, see Table K8S object. -

ENCE 1-791.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"k8s" : {
"id" : "00000000-0000-0000-0000-000000000001",
"name" : "k8s_dev",
"agent" : [
{
"ipv4-address" : "192.168.10.2"
}
],
"reuse-datas" : [
{
"tenant-id" : "00000000-0000-0000-0000-000000000004",
"router-id" : "00000000-0000-0000-0000-000000000004"
}
],
"6eaa2006-0eb2-4395-90d9-e351310a8e2d"
],
"net-mode" : "L2",
"related-datas" : [
{
"tenant-id" : "00000000-0000-0000-0000-000000000004",
"router-id" : "00000000-0000-0000-0000-000000000004"
}
],
"device-loopback-ipv4-ipaddress" : "192.168.13.2",
"tenant-list" : [
{
"id" : "00000000-0000-0000-0000-000000000001",
"l23_tenant_id" : "00000000-0000-0000-0000-000000000001"
}
]

iMaster NCE-Fabric
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.1.3 Update a Container Platform by ID
Typical Scenarios
A container platform needs to be updated by ID.
Functions
Update a container platform based on the ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/containerplatform/k8s/{id}

iMaster NCE-Fabric


ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters


container
platform.

iMaster NCE-Fabric
Table 1-800 K8sDtoWrapper parameters

k8s Yes REFER For details, see K8S object. -

ENCE Table 1-801.
Table 1-801 K8sDto parameters

id No string 36 - Container "00000000-000

ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name Yes string 1 to - Container "k8s_dev"

128 platform name.
charac
ters.
tenant No string 1 to - Tenant name. "tenant"

-name 255
charac
ters.

iMaster NCE-Fabric

agent Yes ARRAY For details, see Agent object. -

_REFER Table 1-802.
ENCE
multi- Yes boolea - - Whether multi- false

reuse- No ARRAY For details, see Reused data -

datas _REFER Table 1-803. list.
ENCE
related No array< Each - List of -

-fabric string> item associated
has 36 fabric IDs.
charac
ters.
status No string 1 to 32 - K8S status. -

charac
ters.
monito No int32 - - Listening port. 11111

r-port
net- Yes string - - Network mode "L2"

mode of the
container
platform,
which can be
L2, L3, or L2L3.
related No ARRAY For details, see Associated -

-datas _REFER Table 1-804. data list.
ENCE
device- No string - - Loopback IPv6 -

ck- device.
ipv6-
ipaddr
ess
device- No string - - Loopback IPv4 "192.168.13.2"

ck- device.
ipv4-
ipaddr
ess

iMaster NCE-Fabric

cni- No string - - CNI mode of -

type the container
network, which
can be Hwcni
or Calico.
Table 1-802 agent parameters

status No string ● onli - The connection -

ne status.
● offli
ne
ipv4- Yes string - - IP address of "192.168.10.2"

addres the K8s
s monitor.

iMaster NCE-Fabric
Table 1-803 ReuseDataDto parameters

tenant Yes string 36 - Multiplexed "00000000-000

-id charac Layer 2/Layer 3 0-0000-0000-0
ters. tenant ID 00000000004"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

router- No string 36 - Multiplexed "00000000-000

id charac Layer 2/Layer 3 0-0000-0000-0
ters. logical router 00000000004"
The ID
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric
Table 1-804 RelatedDataDto parameters

tenant Yes string 36 - Multiplexed "00000000-000

-id charac Layer 2/Layer 3 0-0000-0000-0
ters. tenant ID 00000000004"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

router- Yes string 36 - Multiplexed "00000000-000

id charac Layer 2/Layer 3 0-0000-0000-0
ters. logical router 00000000004"
The ID
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Sample Request
HTTP
PUT /controller/dc/v2/containerplatform/k8s/00000000-0000-0000-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"k8s" : {
"id" : "00000000-0000-0000-0000-000000000001",
"name" : "k8s_dev",
"agent" : [
{
"ipv4-address" : "192.168.10.2"
}
],
"reuse-datas" : [
{
"tenant-id" : "00000000-0000-0000-0000-000000000004",

iMaster NCE-Fabric
"router-id" : "00000000-0000-0000-0000-000000000004"
}
],
"6eaa2006-0eb2-4395-90d9-e351310a8e2d"
],
"net-mode" : "L2",
"related-datas" : [
{
"tenant-id" : "00000000-0000-0000-0000-000000000004",
"router-id" : "00000000-0000-0000-0000-000000000004"
}
],
"device-loopback-ipv4-ipaddress" : "192.168.13.2"
}
}
Response Parameters
Table 1-805 K8sDtoWrapper parameters

eter t Value
k8s REFER For details, see Table K8S object. -

ENCE 1-806.
Table 1-806 K8sDto parameters

eter t Value
id string 36 characters. - Container "00000000-000

The value must platform ID. 0-0000-0000-0
meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 128 - Container "k8s_dev"

characters. platform name.
tenant string 1 to 255 - Tenant name. "tenant"

-name characters.

iMaster NCE-Fabric

eter t Value
agent ARRAY For details, see Table Agent object. -

_REFER 1-792.
ENCE
multi- boolea - - Whether multi- false

reuse- ARRAY For details, see Table Reused data -

datas _REFER 1-793. list.
ENCE
related array< Each item has - List of -

-fabric string> 36 characters. associated
fabric IDs.
status string 1 to 32 - K8S status. -

characters.
monito int32 - - Listening port. 11111

r-port
net- string - - Network mode "L2"

mode of the
container
platform,
which can be
L2, L3, or L2L3.
related ARRAY For details, see Table Associated -

-datas _REFER 1-794. data list.
ENCE
device- string - - Loopback IPv6 -

ck- device.
ipv6-
ipaddr
ess
device- string - - Loopback IPv4 "192.168.13.2"

ck- device.
ipv4-
ipaddr
ess
cni- string - - CNI mode of -

type the container
network, which
can be Hwcni
or Calico.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"k8s" : {
"id" : "00000000-0000-0000-0000-000000000001",
"name" : "k8s_dev",
"agent" : [
{
"ipv4-address" : "192.168.10.2"
}
],
"reuse-datas" : [
{
"tenant-id" : "00000000-0000-0000-0000-000000000004",
"router-id" : "00000000-0000-0000-0000-000000000004"
}
],
"6eaa2006-0eb2-4395-90d9-e351310a8e2d"
],
"net-mode" : "L2",
"related-datas" : [
{
"tenant-id" : "00000000-0000-0000-0000-000000000004",
"router-id" : "00000000-0000-0000-0000-000000000004"
}
],
"device-loopback-ipv4-ipaddress" : "192.168.13.2"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.6.1.4 Check Connectivity Between the Container Platform and the Controller
Typical Scenarios
The availability of the northbound connection between a container platform and
the controller needs to be checked.
Functions
Maintain the heartbeat of the northbound connection between a container
platform and the controller.
Constraints
HTTP Method
PUT
URI
/controller/dc/v2/containerplatform/k8s/{id}/northheartbeat

iMaster NCE-Fabric


ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters


ENCE Table 1-809. checking
whether the
northbound
plug-in of the
container
platform is
available.

iMaster NCE-Fabric
Table 1-809 K8sHeartBeatWrapper parameters

agent_ Yes string 1 to - IP address of "192.168.3.2"

ip 255 the container
charac platform node
ters. for checking
the heartbeat.
Sample Request
HTTP
PUT /controller/dc/v2/containerplatform/k8s/00000000-0000-0000-0000-000000000001/northheartbeat
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"agent_ip" : "192.168.3.2"
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.2 Container Tenant

Third-party northbound API for managing container tenants
1.9.6.2.1 Create a Tenant
Typical Scenarios
A tenant needs to be created.
Functions
Create a tenant.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/containerplatform/tenants
Request Parameters


tenant.

iMaster NCE-Fabric
Table 1-811 TenantDtosWrapper parameters

tenant Yes ARRAY For details, see Tenant list. -

s _REFER Table 1-812.
ENCE
k8s_id Yes string 36 - K8S platform "00000000-000

charac ID. 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

id No string 36 - Tenant ID. "00000000-000

charac 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name Yes string 1 to - Tenant name. "tenant_name"

255
charac
ters.

iMaster NCE-Fabric

l23_te No string 36 - Layer 2 or "00000000-000

nant_i charac Layer 3 tenant 0-0000-0000-0
d ters. ID. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Sample Request
HTTP
POST /controller/dc/v2/containerplatform/tenants HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"tenants" : [
{
"id" : "00000000-0000-0000-0000-000000000001",
"l23_tenant_id" : "00000000-0000-0000-0000-000000000001"
}
],
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}

iMaster NCE-Fabric
Response Parameters
Table 1-813 TenantDtosWrapper parameters

eter t Value

s _REFER 1-814.
ENCE
k8s_id string 36 characters. - K8S platform "00000000-000

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

eter t Value

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

characters.

iMaster NCE-Fabric

eter t Value

d meet the ID. 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenants" : [
{
"id" : "00000000-0000-0000-0000-000000000001",
"l23_tenant_id" : "00000000-0000-0000-0000-000000000001"
}
],
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.6.2.2 Query All Tenants
Typical Scenarios
The tenant list needs to be queried.
Functions
Query the tenant list.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/tenants


dex number.

ze
queryV No string - - queryValue -

alue
order No string - - Order. -

iMaster NCE-Fabric

k8sId No string 36 - K8S platform -

charac ID.
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/tenants?pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-816 TenantQueryDtoWrapper parameters

eter t Value

s _REFER 1-817.
ENCE

num of tenants.
Table 1-817 TenantQueryDto parameters

eter t Value

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

characters.

d meet the ID. 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenants" : [
{
"id" : "00000000-0000-0000-0000-000000000001",
"l23_tenant_id" : "00000000-0000-0000-0000-000000000001",
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
],
"total-num" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.6.2.3 Query a Tenant by ID
Typical Scenarios
A tenant needs to be queried by ID.
Functions
Query a tenant by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/tenants/{id}

iMaster NCE-Fabric

id Yes string 36 - Tenant ID. "00000000-000

charac 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/tenants/00000000-0000-0000-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-819 TenantDtoWrapper parameters

eter t Value
tenant REFER For details, see Table Tenant object. -

ENCE 1-814.

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenant" : {
"id" : "00000000-0000-0000-0000-000000000001",
"l23_tenant_id" : "00000000-0000-0000-0000-000000000001"
},
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.2.4 Delete a Tenant by ID
Typical Scenarios
A tenant needs to be deleted based on the ID.
Functions
Delete a tenant based on the ID.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v2/containerplatform/tenants/{id}

iMaster NCE-Fabric

id Yes string 36 - Tenant ID. "00000000-000

charac 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/containerplatform/tenants/00000000-0000-0000-0000-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.3 Container Network

Third-party northbound API for creating a container network
1.9.6.3.1 Create a Network
Typical Scenarios
A network needs to be created.
Functions
Create a network.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v2/containerplatform/networks
Request Parameters


ks ENCE Table 1-822. creating a
network.
Table 1-822 NetworkDtosWrapper parameters

networ Yes ARRAY For details, see Network object -

ks _REFER Table 1-823. list.
ENCE

iMaster NCE-Fabric


charac ID. 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Table 1-823 NetworkDto parameters

subnet Yes ARRAY 1-255 items. For List of subnets -

s _REFER details, see on a network.
ENCE Table 1-824.
name Yes string 1 to - Network name. "testNetwork"

255
charac
ters.

iMaster NCE-Fabric

tenant Yes string 36 - Tenant ID. Only "00000000-000

_id charac the 0-0000-0000-0
ters. administrator 00000000005"
The can specify the
value tenant ID of
must other tenants.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

id No string 36 - Network ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
networ Yes string ● vlan - Network type, "vlan"

k_type which can be
● vxla
n VLAN or
VXLAN.
segme Yes int32 [1-167 - Extended 10

ntation 77215] attribute:
_id network
segment ID.
For a VLAN
network, the
value is the
VLAN ID. For a
VXLAN
network, the
value is the
VNI.

iMaster NCE-Fabric

fwdmo No string ● brid - Forwarding "bridge"

de ge type: bridge or
● rout routing.
ing
Table 1-824 SubnetDto parameters

id No string 36 - Subnet ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
cidr Yes string 1 to 36 - CIDR address, "192.168.1.0/24

charac which can be "
ters. IPv4 or IPv6
gatew Yes string 1 to 64 - Gateway IP "192.168.1.1"

ay_ip charac address.
ters.

iMaster NCE-Fabric

ip_vers Yes string ● ipv4 - IP version. "ipv4"

ion
● ipv6
Sample Request
HTTP
POST /controller/dc/v2/containerplatform/networks HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"networks" : [
{
"subnets" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gateway_ip" : "192.168.1.1",
"ip_version" : "ipv4"
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"network_type" : "vlan",
"fwdmode" : "bridge"
}
],
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
Response Parameters
Table 1-825 NetworkDtosWrapper parameters

eter t Value
networ ARRAY For details, see Table Network object -

ks _REFER 1-826. list.
ENCE

iMaster NCE-Fabric

eter t Value

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

eter t Value
subnet ARRAY 1-255 items. For details, List of subnets -

s _REFER see Table 1-827. on a network.
ENCE

characters.
tenant string 36 characters. - Tenant ID. Only "00000000-000

_id The value must the 0-0000-0000-0
meet the administrator 00000000005"
following can specify the
regular tenant ID of
expression: other tenants.
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
id string 36 characters. - Network ID. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
networ string ● vlan - Network type, "vlan"

k_type which can be
● vxlan
VLAN or
VXLAN.
segme int32 [1-16777215] - Extended 10

ntation attribute:
_id network
segment ID.
For a VLAN
network, the
value is the
VLAN ID. For a
VXLAN
network, the
value is the
VNI.
fwdmo string ● bridge - Forwarding "bridge"

de type: bridge or
● routing
routing.

iMaster NCE-Fabric

eter t Value
id string 36 characters. - Subnet ID. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
cidr string 1 to 36 - CIDR address, "192.168.1.0/24

characters. which can be "
IPv4 or IPv6
gatew string 1 to 64 - Gateway IP "192.168.1.1"

ay_ip characters. address.
ip_vers string ● ipv4 - IP version. "ipv4"

ion
● ipv6
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"networks" : [
{
"subnets" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gateway_ip" : "192.168.1.1",
}

iMaster NCE-Fabric
],
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
],
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.3.2 Query All Networks
Typical Scenarios
All networks need to be queried.
Functions
Query all networks.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/networks

iMaster NCE-Fabric

k8sId No string 36 - K8S platform "DBB702C3-77

charac ID. 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

tenantI No string 36 - Tenant ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65300"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/networks?k8sId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&tenantId=DBB702C3-7719-4FE6-A5AD-3A9C9E265300 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-829 NetworkQueryDtoWrapper parameters

eter t Value
networ ARRAY For details, see Table Network object -

ks _REFER 1-830. list.
ENCE

num of networks.
Table 1-830 NetworkQueryDto parameters

eter t Value
subnet ARRAY 1-255 items. For details, List of subnets -

s _REFER see Table 1-827. on a network.
ENCE

characters.
tenant string 36 characters. - Tenant ID. Only "00000000-000

_id The value must the 0-0000-0000-0
meet the administrator 00000000005"
following can specify the
regular tenant ID of
expression: other tenants.
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
id string 36 characters. - Network ID. "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
networ string ● vlan - Network type, "vlan"

k_type which can be
● vxlan
VLAN or
VXLAN.
segme int32 [1-16777215] - Extended 10

ntation attribute:
_id network
segment ID.
For a VLAN
network, the
value is the
VLAN ID. For a
VXLAN
network, the
value is the
VNI.

de type: bridge or
● routing
routing.

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"networks" : [
{
"subnets" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gateway_ip" : "192.168.1.1",
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fwdmode" : "bridge",
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
],
"total-num" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.3.3 Query a Network by ID
Typical Scenarios
A network needs to be queried by ID.
Functions
Query a network by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/networks/{id}

id Yes string 36 - Network ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/networks/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters

eter t Value

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
networ REFER For details, see Table Network -

k ENCE 1-826. object.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"k8s_id" : "00000000-0000-0000-0000-000000000001",
"network" : {
"subnets" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gateway_ip" : "192.168.1.1",

iMaster NCE-Fabric
}
],
"tenant_id" : "00000000-0000-0000-0000-000000000005",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.3.4 Delete a Network by ID
Typical Scenarios
A network needs to be deleted by ID. After a network is deleted, all the
corresponding subnets are deleted.
Functions
Delete a network by ID.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v2/containerplatform/networks/{id}

iMaster NCE-Fabric

id Yes string 36 - Network ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/containerplatform/networks/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.4 Container Port

Third-party northbound API for creating a container port.
1.9.6.4.1 Create a Port
Typical Scenarios
Functions
Create a port.
Constraints
Concurrency specification: ≤ 10,000 times/minute.

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v2/containerplatform/ports
Request Parameters

portDt Yes REFER For details, see Parameters for -

oWrap ENCE Table 1-835. creating a port.
per
Table 1-835 PortDtosWrapper parameters

ports Yes ARRAY For details, see Total number -

_REFER Table 1-836. of container
ENCE ports.

iMaster NCE-Fabric


charac ID. 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

name Yes string 1 to - Port name. "test_name"

255
charac
ters.
names No string 0 to - Name space "namespace1"

pace 128
charac
ters.

iMaster NCE-Fabric

id No string 36 - Container port "DBB702C3-77

charac ID. 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

networ No string 0 to 36 - Network ID. "DBB702C3-77

ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
([0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12})|
().
mac_a No string 1 to 32 - MAC address "fa:16:3e:9e:ff:

ddress charac of a port. 55"
ters.
fixed_i Yes ARRAY For details, see IP address of a -

ps _REFER Table 1-837. port.
ENCE

iMaster NCE-Fabric

tenant Yes string 36 - Tenant ID. "14c6bc47-5a5

_id charac c-47da-
ters. bff3-7ed2b0ca
The 8c8f"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
status No string 0 to - Port status. -

128
charac
ters.

iMaster NCE-Fabric

host_id Yes string 1 to - Extended "compute-192.

255 attribute: host 168.8.161"
charac ID. In the
ters. distributed
hybrid overlay
solution, this
parameter is
mandatory and
the value is the
ID of the
CE1800V. In
the network
overlay
solution, this
parameter is
optional and
the value is the
host name of
the compute
node where
the VM is
located.
fwdmo No string ● brid - Forwarding "bridge"

de ge mode: bridge
● rout or routing.
ing

iMaster NCE-Fabric

subnet No string 0 to 36 - Subnet ID "DBB702C3-77

_id charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
([0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12})|
().
ip_add Yes string 1 to 64 - IP address. "192.168.10.16

ress charac "
ters.
Sample Request
HTTP
POST /controller/dc/v2/containerplatform/ports HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"ports" : [
{
"namespace" : "namespace1",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"fixed_ips" : [
{
"ip_address" : "192.168.10.16"
}
],
"host_id" : "compute-192.168.8.161",
}
],
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
Response Parameters
Table 1-838 PortDtosWrapper parameters

eter t Value
ports ARRAY For details, see Table Total number -

_REFER 1-839. of container
ENCE ports.

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

eter t Value

characters.
names string 0 to 128 - Name space "namespace1"

pace characters.

iMaster NCE-Fabric

eter t Value
id string 36 characters. - Container port "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

k_id characters. The 19-4FE6-
value must A5AD-3A9C9E2
meet the 65309"
following
regular
expression:
([0-9a-fA-F]
{8}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{12})|().
mac_a string 1 to 32 - MAC address "fa:16:3e:9e:ff:

ddress characters. of a port. 55"
fixed_i ARRAY For details, see Table IP address of a -

ps _REFER 1-840. port.
ENCE
tenant string 36 characters. - Tenant ID. "14c6bc47-5a5

_id The value must c-47da-
meet the bff3-7ed2b0ca
following 8c8f"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
status string 0 to 128 - Port status. -

characters.

iMaster NCE-Fabric

eter t Value
host_id string 1 to 255 - Extended "compute-192.

characters. attribute: host 168.8.161"
ID. In the
distributed
hybrid overlay
solution, this
parameter is
mandatory and
the value is the
ID of the
CE1800V. In
the network
overlay
solution, this
parameter is
optional and
the value is the
host name of
the compute
node where
the VM is
located.

de mode: bridge
● routing
or routing.

eter t Value

_id characters. The 19-4FE6-
meet the 65309"
following
regular
expression:
([0-9a-fA-F]
{8}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{12})|().
ip_add string 1 to 64 - IP address. "192.168.10.16

ress characters. "

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ports" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{
"ip_address" : "192.168.10.16"
}
],
"host_id" : "compute-192.168.8.161",
}
],
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Typical Scenarios
Functions
Query all ports.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/ports

iMaster NCE-Fabric

k8sId No string 36 - Container -

charac platform ID.
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

tenantI No string 36 - Tenant ID. -

d charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

networ No string 36 - Network ID. -

kId charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/ports HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-842 PortQueryDtoWrapper parameters

eter t Value
ports ARRAY For details, see Table Port list. -

_REFER 1-843.
ENCE

num of container
ports.
Table 1-843 PortQueryDto parameters

eter t Value

characters.
names string 0 to 128 - Name space "namespace1"

pace characters.
id string 36 characters. - Container port "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

k_id characters. The 19-4FE6-
meet the 65309"
following
regular
expression:
([0-9a-fA-F]
{8}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{4}-[0-9a-fA-F]
{12})|().

iMaster NCE-Fabric

eter t Value
mac_a string 1 to 32 - MAC address "fa:16:3e:9e:ff:

ddress characters. of a port. 55"
fixed_i ARRAY For details, see Table IP address of a -

ps _REFER 1-840. port.
ENCE
tenant string 36 characters. - Tenant ID. "14c6bc47-5a5

_id The value must c-47da-
meet the bff3-7ed2b0ca
following 8c8f"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
status string 0 to 128 - Port status. -

characters.
host_id string 1 to 255 - Extended "compute-192.

characters. attribute: host 168.8.161"
ID. In the
distributed
hybrid overlay
solution, this
parameter is
mandatory and
the value is the
ID of the
CE1800V. In
the network
overlay
solution, this
parameter is
optional and
the value is the
host name of
the compute
node where
the VM is
located.

de mode: bridge
● routing
or routing.

iMaster NCE-Fabric

eter t Value

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"ports" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{
"ip_address" : "192.168.10.16"
}
],
"host_id" : "compute-192.168.8.161",
"fwdmode" : "bridge",
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
],
"total-num" : 10
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.4.3 Query a Port by ID
Typical Scenarios
Query a Port by ID.
Functions
Query a port by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/ports/{id}

iMaster NCE-Fabric

id Yes string 36 - Port ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/ports/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-845 PortDtoWrapper parameters

eter t Value
port REFER For details, see Table Port -


meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{
"ip_address" : "192.168.10.16"
}
],
"host_id" : "compute-192.168.8.161",
},
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.4.4 Update a Port by ID
Typical Scenarios
Functions
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes string 36 - Port ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

portDt Yes REFER For details, see Parameters for -

oWrap ENCE Table 1-848. updating a
per port.

iMaster NCE-Fabric

port Yes REFER For details, see Port -


charac ID. 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Sample Request
HTTP
PUT /controller/dc/v2/containerplatform/ports/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"port" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [

iMaster NCE-Fabric
{
"ip_address" : "192.168.10.16"
}
],
"host_id" : "compute-192.168.8.161",
},
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
Response Parameters
PortDtoWrapper parameters, For details, see Table 1-845.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fixed_ips" : [
{
"ip_address" : "192.168.10.16"
}
],
"host_id" : "compute-192.168.8.161",
},
"k8s_id" : "00000000-0000-0000-0000-000000000001"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.4.5 Delete a Port by ID
Typical Scenarios
Functions
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric

id Yes string 36 - Port name. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/containerplatform/ports/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.5 Container Node

Third-party northbound APIs for managing container nodes
1.9.6.5.1 Create a Container Node
Typical Scenarios
Create a Container Node.
Functions
Create a container node.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v2/containerplatform/nodes
Request Parameters

nodeD Yes REFER For details, see Parameters for -

toWra ENCE Table 1-851. creating a
pper container node.
Table 1-851 NodeDtoWrapper parameters

node Yes REFER For details, see - -

ENCE Table 1-852.
Table 1-852 NodeDto parameters

name Yes string 1 to - Node name. "calico_node_n

255 ame"
charac
ters.
k8s_no Yes string 1 to - Name of a K8s "k8s_node_host

de_na 255 node. _name"
me charac
ters.
id No uuid 1 to 36 - Node ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

k8s_id Yes uuid 1 to 36 - Container "DBB702C3-77

charac platform ID. 19-4FE6-
ters. A5AD-3A9C9E2
65309"
node_i No string 1 to - Node IP -

pv6_ad 256 address
dress charac version, which
ters. can be IPv4 or
IPv6
node_i Yes string 1 to - Node IP "192.168.73.16

pv4_ad 256 address. "
dress charac
ters.
as_nu Yes string 0 to - Node AS "100"

mber 255 number.
charac
ters.
Sample Request
HTTP
POST /controller/dc/v2/containerplatform/nodes HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"node" : {
"name" : "calico_node_name",
"k8s_node_name" : "k8s_node_host_name",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"k8s_id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"node_ipv4_address" : "192.168.73.16",
"as_number" : "100"
}
}
Response Parameters

iMaster NCE-Fabric
Table 1-853 NodeQueryDtoWrapper parameters

eter t Value
node REFER - - node -

ENCE
Table 1-854 NodeQueryDto parameters

eter t Value
name string 1 to 255 - Node name. "calico_node_n

characters. ame"
k8s_no string 1 to 255 - Name of a K8s "k8s_node_host

de_na characters. node. _name"
me
id uuid 1 to 36 - Node ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
k8s_id uuid 1 to 36 - Container "DBB702C3-77

characters. platform ID. 19-4FE6-
A5AD-3A9C9E2
65309"
node_i string 1 to 256 - Node IP -

pv6_ad characters. address
dress version, which
can be IPv4 or
IPv6
node_i string 1 to 256 - Node IP "192.168.73.16

pv4_ad characters. address. "
dress
as_nu string 0 to 255 - Node AS "100"

mber characters. number.
peer_in ARRAY For details, see Table Peer -

fo _REFER 1-855. information of
ENCE a node

iMaster NCE-Fabric
Table 1-855 PeerDto parameters

eter t Value
peer_ip string 1 to 256 - Peer IP address "192.168.83.16

v4_add characters. of a node. "
ress
peer_ip string 1 to 256 - Peer IP address -

v6_add characters. of a node.
ress
peer_a string 0 to 128 - AS number of "101"

s characters. a TOR switch.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"node" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"node_ipv4_address" : "192.168.73.16",
"as_number" : "100",
"peer_info" : [
{
"peer_ipv4_address" : "192.168.83.16",
"peer_as" : "101"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.5.2 Query All Container Nodes
Typical Scenarios
All container nodes need to be queried.
Functions
Query all container nodes.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/nodes

k8sId No UUID - - k8s ID -
name No string - - Node name. -
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /controller/dc/v2/containerplatform/nodes HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-857 NodeQueryListDtoWrapper parameters

eter t Value
nodes ARRAY For details, see Table Node list. -

_REFER 1-858.
ENCE
total- int32 - - - 1
num
Table 1-858 NodeQueryDto parameters

eter t Value
name string 1 to 255 - Node name. "calico_node_n

characters. ame"
k8s_no string 1 to 255 - Name of a K8s "k8s_node_host

de_na characters. node. _name"
me
id uuid 1 to 36 - Node ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
k8s_id uuid 1 to 36 - Container "DBB702C3-77

characters. platform ID. 19-4FE6-
A5AD-3A9C9E2
65309"
node_i string 1 to 256 - Node IP -

pv6_ad characters. address
dress version, which
can be IPv4 or
IPv6

iMaster NCE-Fabric

eter t Value
node_i string 1 to 256 - Node IP "192.168.73.16

pv4_ad characters. address. "
dress
as_nu string 0 to 255 - Node AS "100"

mber characters. number.
peer_in ARRAY For details, see Table Peer -

fo _REFER 1-855. information of
ENCE a node
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"nodes" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"node_ipv4_address" : "192.168.73.16",
"peer_info" : [
{
"peer_ipv4_address" : "192.168.83.16",
"peer_as" : "101"
}
]
}
],
"total-num" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.5.3 Query a Container Node by ID
Typical Scenarios
A container node needs to be queried by ID.
Functions
Query a container node based on the ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/nodes/{id}

id Yes UUID 1 to 36 - Node ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
60001"
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /controller/dc/v2/containerplatform/nodes/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
NodeQueryDtoWrapper parameters, For details, see Table 1-853.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"node" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"node_ipv4_address" : "192.168.73.16",
"peer_info" : [
{
"peer_ipv4_address" : "192.168.83.16",
"peer_as" : "101"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.6.5.4 Update a Container Node by ID
Typical Scenarios
A container node needs to be updated by ID.
Functions
Update a container node by ID.
Constraints
HTTP Method
PUT
URI

id Yes UUID 1 to 36 - Node ID. -

charac
ters.
Request Parameters


container node.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v2/containerplatform/nodes/{id} HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"node" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"node_ipv4_address" : "192.168.73.16",
"as_number" : "100"
}
}
Response Parameters
NodeQueryDtoWrapper parameters, For details, see Table 1-853.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"node" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"node_ipv4_address" : "192.168.73.16",
"peer_info" : [
{
"peer_ipv4_address" : "192.168.83.16",
"peer_as" : "101"
}
]
}
]
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.5.5 Delete a Container Node by ID
Typical Scenarios
A container node needs to be deleted by ID.
Functions
Delete a container node based on the ID.
Constraints
HTTP Method
DELETE
URI

id Yes UUID 1 to 36 - Node ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
60001"

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/containerplatform/nodes/DBB702C3-7719-4FE6-A5AD-3A9C9E260001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.6 Container Services

Third-party northbound APIs for managing the container platform

iMaster NCE-Fabric
1.9.6.6.1 Create a container service.
Typical Scenarios
A container service needs to be created.
Functions
Create a container service.
Constraints
HTTP Method
POST
URI
/controller/dc/v2/containerplatform/services
Request Parameters

service Yes REFER For details, see Request body -

ENCE Table 1-864. for creating a
service.
Table 1-864 ServiceDtosWrapper parameters

service Yes ARRAY For details, see service -

ENCE

iMaster NCE-Fabric

k8sId Yes string 36 - K8S platform "00000000-000

charac ID. 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric
Table 1-865 ServiceDto parameters

id No string 36 - Service ID. "ABB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string - - name -

iMaster NCE-Fabric

tenantI No string 36 - Tenant ID. "CDB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
names No string - - namespace -

pace
type No string - - type -
clusterI No string - - clusterIp -

p
service No string - - serviceStatus -

Status
ports No ARRAY For details, see Port list. -

_REFER Table 1-866.
ENCE
endpoi No REFER For details, see Endpoint list -

nts ENCE Table 1-867. instance.

iMaster NCE-Fabric
Table 1-866 ServicePortDto parameters

portId No string 36 - PORT ID "CBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60001"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
nodeP No int32 [1-214 - Node port 10

ort 74836 number.
47]
port No int32 [1-214 - Port number. 10

74836
47]
protoc No string - - Network -

ol protocol.
targetP No int32 [1-214 - Destination 10

ort 74836 port number.
47]

iMaster NCE-Fabric
Table 1-867 EndpointsDto parameters

endpoi No ARRAY For details, see Endpoint list. -

ntList _REFER Table 1-868.
ENCE
Table 1-868 EndPointDto parameters

id No string - - epID -
kind No string - - Category. -
ip No string - - IP address. -
Sample Request
HTTP
POST /controller/dc/v2/containerplatform/services HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"services" : [
{
"id" : "ABB702C3-7719-4FE6-A5AD-3A9C9E260001",
"tenantId" : "CDB702C3-7719-4FE6-A5AD-3A9C9E260001",
"ports" : [
{
"portId" : "CBB702C3-7719-4FE6-A5AD-3A9C9E260001",
"nodePort" : 10,
"port" : 10,
"targetPort" : 10
}
]
}
],
"k8sId" : "00000000-0000-0000-0000-000000000001"
}
Response Parameters

iMaster NCE-Fabric
Table 1-869 ServiceDtosWrapper parameters

eter t Value
service ARRAY For details, see Table service -

s _REFER 1-870.
ENCE
k8sId string 36 characters. - K8S platform "00000000-000

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Table 1-870 ServiceDto parameters

eter t Value
id string 36 characters. - Service ID. "ABB702C3-77

following 60001"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string - - name -

iMaster NCE-Fabric

eter t Value
tenantI string 36 characters. - Tenant ID. "CDB702C3-77

following 60001"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
names string - - namespace -

pace
type string - - type -
clusterI string - - clusterIp -

p
service string - - serviceStatus -

Status

_REFER 1-871.
ENCE
endpoi REFER For details, see Table Endpoint list -

nts ENCE 1-872. instance.
Table 1-871 ServicePortDto parameters

eter t Value
portId string 36 characters. - PORT ID "CBB702C3-77

following 60001"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
nodeP int32 [1-2147483647 - Node port 10

ort ] number.
port int32 [1-2147483647 - Port number. 10

]
protoc string - - Network -

ol protocol.
targetP int32 [1-2147483647 - Destination 10

ort ] port number.
Table 1-872 EndpointsDto parameters

eter t Value
endpoi ARRAY For details, see Table Endpoint list. -

ntList _REFER 1-873.
ENCE
Table 1-873 EndPointDto parameters

eter t Value
id string - - epID -
kind string - - Category. -
ip string - - IP address. -
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"services" : [
{
"id" : "ABB702C3-7719-4FE6-A5AD-3A9C9E260001",
"ports" : [
{
"nodePort" : 10,
"port" : 10,
"targetPort" : 10
}
]
}
],
"k8sId" : "00000000-0000-0000-0000-000000000001"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.6.2 Query Container Services
Typical Scenarios
The container service list needs to be queried.
Functions
Query the container service list.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v2/containerplatform/services


dex number.

ze
queryV No string - - Service name. "servicename"

alue
order No string - - Order. "true"
tenantI No string 36 - Tenant ID. "CBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60008"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/services?
pageIndex=1&pageSize=10&queryValue=servicename&order=true&tenantId=CBB702C3-7719-4FE6-
A5AD-3A9C9E260008 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-875 ServiceQueryDtoWrapper parameters

eter t Value
service ARRAY For details, see Table Service list. -

s _REFER 1-876.
ENCE
totalN int32 - - Statistics. 10

um
Table 1-876 ServiceQueryDto parameters

eter t Value
id string 36 characters. - Service ID. "ABB702C3-77

following 60001"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string - - name -

iMaster NCE-Fabric

eter t Value
tenantI string 36 characters. - Tenant ID. "CDB702C3-77

following 60001"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
names string - - namespace -

pace
type string - - type -
clusterI string - - clusterIp -

p
service string - - serviceStatus -

Status

_REFER 1-871.
ENCE
endpoi REFER For details, see Table Endpoint list -

nts ENCE 1-872. instance.

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"services" : [
{
"id" : "ABB702C3-7719-4FE6-A5AD-3A9C9E260001",
"ports" : [
{
"nodePort" : 10,
"port" : 10,
"targetPort" : 10
}
],
"k8sId" : "00000000-0000-0000-0000-000000000001"
}
],
"totalNum" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.6.3 Query a Container Service by ID
Typical Scenarios
The container service with a specified ID needs to be queried.
Functions
Query a container service.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v2/containerplatform/services/service/{id}

id Yes string 36 - Service ID. "CBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
The 60005"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v2/containerplatform/services/service/CBB702C3-7719-4FE6-A5AD-3A9C9E260005 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-878 ServiceDtoWrapper parameters

eter t Value
service REFER For details, see Table service -

ENCE 1-870.

meet the 00000000001"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"service" : {
"id" : "ABB702C3-7719-4FE6-A5AD-3A9C9E260001",
"ports" : [
{
"nodePort" : 10,
"port" : 10,
"targetPort" : 10
}
]
},
"k8sId" : "00000000-0000-0000-0000-000000000001"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.6.6.4 Modify a Container Service
Typical Scenarios
A container service needs to be modified.
Functions
Modify a container service.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes string 36 - Container "CBB702C3-77

charac service ID. 19-4FE6-
ters. A5AD-3A9C9E2
The 60004"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

service Yes REFER For details, see Request body -

ENCE Table 1-881. for updating a
service.

iMaster NCE-Fabric
Table 1-881 ServiceDtoWrapper parameters

service Yes REFER For details, see service -

ENCE Table 1-865.
k8sId Yes string 36 - K8S platform "00000000-000

charac ID. 0-0000-0000-0
ters. 00000000001"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Sample Request
HTTP
PUT /controller/dc/v2/containerplatform/services/service/CBB702C3-7719-4FE6-A5AD-3A9C9E260004 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"service" : {
"id" : "ABB702C3-7719-4FE6-A5AD-3A9C9E260001",
"ports" : [
{

iMaster NCE-Fabric
"nodePort" : 10,
"port" : 10,
"targetPort" : 10
}
]
},
"k8sId" : "00000000-0000-0000-0000-000000000001"
}
Response Parameters
ServiceDtoWrapper parameters, For details, see Table 1-878.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"service" : {
"id" : "ABB702C3-7719-4FE6-A5AD-3A9C9E260001",
"ports" : [
{
"nodePort" : 10,
"port" : 10,
"targetPort" : 10
}
]
},
"k8sId" : "00000000-0000-0000-0000-000000000001"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.6.6.5 Delete a container service.
Typical Scenarios
A container service needs to be deleted.
Functions
Delete a container service.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric

id Yes string 36 - Container "CBB702C3-77

charac service ID. 19-4FE6-
ters. A5AD-3A9C9E2
The 60002"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v2/containerplatform/services/service/CBB702C3-7719-4FE6-A5AD-3A9C9E260002
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7 VPC
1.9.7.1 Logical Network Management

Description of asset synchronization interface provided
for the vulnerability awareness system to query device information in the
CloudSOP inventory table.
**SLA**
|SLA Item|Definition|
|-----|-----|
|Request success rate| ≥ 99.9%|
|Availability|Tier 1|
|Data consistency|Eventual consistency, inconsistency duration < 1 minute|
|Throughput|4000 TPS|

iMaster NCE-Fabric
|TP50 request delay | 50 ms |

|TP99.9 request delay | 100 ms |
1.9.7.1.1 Create a Logical Network
Typical Scenarios
A logical network needs to be created.
Functions
Create a logical network. The following fields are mandatory: id, name, and
fabricId.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/networks
Request Parameters

er Range Value on

NCE 1-884. s for
creating a
logical
network.
Table 1-884 LogicNetworkDtoWrapper parameters

networ Yes REFER For details, see Logical -

k ENCE Table 1-885. network
information.

iMaster NCE-Fabric

id Yes string 36 - Logical "DBB702C3-77

charac network ID. 19-4FE6-
ters. This field A5AD-3A9C9E2
The cannot be 65309"
value updated.
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 1 to - Tenant to "vpcName"

255 which a logical
charac network (VPC)
ters. belongs. If this
parameter is
left empty, it is
a public VPC.
This field
cannot be
updated.

iMaster NCE-Fabric

descrip No string 0 to - ID of the fabric "description"

tion 255 associated with
charac the logical
ters. network. If the
VPC is not a
public VPC, the
fabric must
have been
added by the
tenant. This
field can be
updated.
tenantI No string 0 to - Tenant to "DBB702C3-77

d 256 which a logical 19-4FE6-
charac network (VPC) A5AD-3A9C9E2
ters. belongs. If this 65309"
parameter is
left empty, it is
a public VPC.
This field
cannot be
updated.
fabricI No array< 0-4000 - ID of the fabric -

d string> items. associated with
the logical
network. If the
VPC is not a
public VPC, the
fabric must
have been
added by the
tenant. This
field can be
updated.
multic No boolea - - Multicast false

astCap n capability. This
ability field can be
updated.

iMaster NCE-Fabric

type No string 0 to 36 - Logical "Transit"

charac network type,
ters. which can be
Instance or
Transit. If this
parameter is
left empty, the
default value is
Instance.
additio No REFER For details, see "" -



specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 16:30:40"
charac
ters.

At 255 16:30:40"
charac
ters.
Sample Request
HTTP

iMaster NCE-Fabric
POST /controller/dc/v3/logicnetwork/networks HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"network" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "vpcName",
"fabricId" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"type" : "Transit",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.1.2 Query All Logical Networks
Typical Scenarios
All logical networks need to be queried.

iMaster NCE-Fabric
Functions
Query all logical networks.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/networks


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
type No string 0 to 36 - Logical "Transit"

charac network type,
ters. which can be
Instance or
Transit.
tenantI No string 0 to - Tenant ID. "DBB702C3-77

d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
filterTe No boolea - true Default tenant false

nant n filtering.

iMaster NCE-Fabric


dex 255 number.
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/networks?
producer=default&type=Transit&tenantId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&filterTenant=false&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-888 LogicNetworkPagedDtoWrapper parameters

eter t Value
networ ARRAY For details, see Table Logical -

k _REFER 1-889. network
ENCE information
list.

um ] of logical
networks.
pageIn int32 [1-2147483647 - Current page 1

dex ] number.

iMaster NCE-Fabric

eter t Value

ze ]
Table 1-889 QueryNetworkDto parameters

eter t Value
id string 36 characters. - Logical "DBB702C3-77

The value must network ID. 19-4FE6-
meet the This field A5AD-3A9C9E2
following cannot be 65309"
regular updated.
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - Tenant to "vpcName"

characters. which a logical
network (VPC)
belongs. If this
parameter is
left empty, it is
a public VPC.
This field
cannot be
updated.
descrip string 0 to 255 - ID of the fabric "description"

tion characters. associated with
the logical
network. If the
VPC is not a
public VPC, the
fabric must
have been
added by the
tenant. This
field can be
updated.

iMaster NCE-Fabric

eter t Value
tenantI string 0 to 256 - Tenant to "DBB702C3-77

d characters. which a logical 19-4FE6-
network (VPC) A5AD-3A9C9E2
belongs. If this 65309"
parameter is
left empty, it is
a public VPC.
This field
cannot be
updated.
fabricI array< 0-4000 items. - ID of the fabric -

d string> associated with
the logical
network. If the
VPC is not a
public VPC, the
fabric must
have been
added by the
tenant. This
field can be
updated.
multic boolea - - Multicast false

updated.
type string 0 to 36 - Logical "Transit"

characters. network type,
which can be
Instance or
Transit. If this
parameter is
left empty, the
default value is
Instance.
additio REFER For details, see Table "" -

nal ENCE 1-890.
isVpcD boolea - - Whether the true

eploye n logical network
d (VPC) is
deployed.

iMaster NCE-Fabric

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.


Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"network" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "vpcName",
"fabricId" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"type" : "Transit",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"

iMaster NCE-Fabric
},
"isVpcDeployed" : true
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Typical Scenarios
A logical network needs to be queried by ID.
Functions
Query a logical network by ID.
The name, description, fabircId, and multicastCapability fields can be updated.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/networks/network/{id}

id Yes string 0 to - Logical "DBB702C3-77

256 network ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/networks/network/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-892 LogicNetworkRestfulDtoWrapper parameters

eter t Value
networ ARRAY For details, see Table Logical -

k _REFER 1-889. network
ENCE information.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"network" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "vpcName",
"fabricId" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"type" : "Transit",
"additional" : {

iMaster NCE-Fabric
"createAt" : "2017-08-10 16:30:40",

"updateAt" : "2017-08-10 16:30:40"
},
"isVpcDeployed" : true
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.1.4 Update a Logical Network by ID
Typical Scenarios
A logical network needs to be updated by ID.
Functions
Modify a logical network based on the logical network ID.
Constraints
HTTP Method
PUT
URI


256 a logical 19-4FE6-
charac network. This A5AD-3A9C9E2
ters. field cannot be 65309"
updated.

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-884. s for
updating
a logical
network.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/networks/network/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"network" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "vpcName",
"fabricId" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"type" : "Transit",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Response Parameters
Table 1-895 LogicNetworkDtoWrapper parameters

eter t Value
networ REFER For details, see Table Logical -

k ENCE 1-896. network
information.

iMaster NCE-Fabric

eter t Value
id string 36 characters. - Logical "DBB702C3-77

The value must network ID. 19-4FE6-
meet the This field A5AD-3A9C9E2
following cannot be 65309"
regular updated.
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - Tenant to "vpcName"

characters. which a logical
network (VPC)
belongs. If this
parameter is
left empty, it is
a public VPC.
This field
cannot be
updated.
descrip string 0 to 255 - ID of the fabric "description"

tion characters. associated with
the logical
network. If the
VPC is not a
public VPC, the
fabric must
have been
added by the
tenant. This
field can be
updated.
tenantI string 0 to 256 - Tenant to "DBB702C3-77

d characters. which a logical 19-4FE6-
network (VPC) A5AD-3A9C9E2
parameter is
left empty, it is
a public VPC.
This field
cannot be
updated.

iMaster NCE-Fabric

eter t Value
fabricI array< 0-4000 items. - ID of the fabric -

d string> associated with
the logical
network. If the
VPC is not a
public VPC, the
fabric must
have been
added by the
tenant. This
field can be
updated.
multic boolea - - Multicast false

updated.
type string 0 to 36 - Logical "Transit"

characters. network type,
which can be
Instance or
Transit. If this
parameter is
left empty, the
default value is
Instance.

nal ENCE 1-890.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"network" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "vpcName",

iMaster NCE-Fabric
"fabricId" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"type" : "Transit",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.1.5 Delete a Logical Network by ID
Typical Scenarios
A logical network needs to be deleted by ID.
Functions
Delete a logical network based by ID. All related services on the logical network
will be deleted.
Constraints
HTTP Method
DELETE
URI


ters. 65309"

iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/networks/network/DBB702C3-7719-4FE6-A5AD-3A9C9E265309?
producer=default HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.2 Logical Subnet Management

Subnet management APIs: 1. Query subnet information. 2. Create subnet
information. 3. Query a subnet by ID. 4. Update a subnet by ID. 5. Delete a subnet
by ID.
1.9.7.2.1 Create a Subnet
Typical Scenarios
A subnet needs to be created.
Functions
Create a subnet.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/subnets
Request Parameters

er Range Value on

NCE 1-900. s for
creating a
subnet.

iMaster NCE-Fabric
Table 1-900 SubnetDtoWrapper parameters

subnet Yes ARRAY For details, see Subnet -

_REFER Table 1-901. information.
ENCE

id Yes string 0 to - Object ID. This "DBB702C3-77

256 field cannot be 19-4FE6-
ters. 65309"
logicS No string 0 to - Subnet "DBB702C3-77

witchId 256 broadcast 19-4FE6-
charac domain. A5AD-3A9C9E2
ters. Reserved 65309"
parameter.
cidr Yes string 1 to - Subnet "192.168.1.0/24

255 segment. This "
charac parameter
ters. cannot be
updated if the
subnet is
associated with
a logical
switch.
gatew No string 1 to - Subnet "192.168.1.1"

ayIp 255 gateway IP
charac address. This
ters. parameter is
optional when
Logical router
type is set to
Multi-active.
This field
cannot be
updated
allocPo No REFER For details, see Reserved -

ol ENCE Table 1-902. parameter.

iMaster NCE-Fabric

reserve No REFER For details, see Reserved -

Pool ENCE Table 1-903. parameter.
tenantI No string 0 to - Tenant. This "DBB702C3-77

charac updated. If a A5AD-3A9C9E2
ters. new value is 65309"
entered during
the update, the
value used
during the
creation is
retained and is
not updated.
logicR No string 0 to - Logical router "DBB702C3-77

outerId 256 ID. This field is 19-4FE6-
charac mandatory A5AD-3A9C9E2
ters. during the 65309"
creation and
optional during
the update.
This field
cannot be
updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.
device No ARRAY For details, see Parameter -

Gatew _REFER Table 1-904. required when
ayIps ENCE the logical
router type is
Multi-active.
vrrpCo No ARRAY For details, see Parameter -

nfig _REFER Table 1-905. required when
ENCE the logical
router type is
Multi-active.


iMaster NCE-Fabric
Table 1-902 AllocPoolDto parameters

ipBegi Yes string 1 to - Start IP "192.168.1.1"

n 255 address.
charac
ters.
ipEnd Yes string 1 to - End IP address. "192.168.1.2"

255
charac
ters.
Table 1-903 ReservePoolDto parameters

ipBegi Yes string 1 to - Start IP "192.168.1.1"

n 255 address.
charac
ters.
ipEnd Yes string 1 to - End IP address. "192.168.1.2"

255
charac
ters.
Table 1-904 DeviceGroupGatewayIpDto parameters


GroupI 256 ID. This field 19-4FE6-
ters. update 65309"
gatew No string - - Only IPv4 "192.168.1.1"

ayIp addresses are
supported. This
field can be
updated.

iMaster NCE-Fabric
Table 1-905 DeviceGroupVrrpDto parameters

id No string 0 to - Object ID. This "DBB702C3-77

ters. 65309"

GroupI 256 ID. This field 19-4FE6-
ters. update 65309"
vrrpVri No string 1 to - VRRP VRID. "10"

d 255 This field can
charac be updated.
ters.
virtualI No string - - Only IPv4 "192.168.1.1"

p addresses are
supported. This
field can be
updated.
vrrpPri No string 1 to - Priority. This "10"

ority 254 field can be
charac updated.
ters.
preem No boolea - - Whether to false

ptEnab n enable
le preemption.
This field can
be updated.
preem No string 0 to - Preemption "10"

pt 3600 time. This field
charac can be
ters. updated.
recover No string 0 to - Delay before a "10"

yDelay 3600 VRRP group
charac recovers. The
ters. value can be
changed.

iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 0:19:41.000+00:
charac 00"
ters.

At 255 0:19:41.000+00:
charac 00"
ters.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/subnets HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"subnet" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"logicSwitchId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gatewayIp" : "192.168.1.1",
"allocPool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
"reservePool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},

iMaster NCE-Fabric
"logicRouterId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceGatewayIps" : [
{
"gatewayIp" : "192.168.1.1"
}
],
"vrrpConfig" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vrrpVrid" : "10",
"virtualIp" : "192.168.1.1",
"vrrpPriority" : "10",
"preemptEnable" : false,
"preempt" : "10",
"recoveryDelay" : "10"
}
],
"additional" : {
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.2.2 Query Subnets
Typical Scenarios
Subnet information needs to be queried.

iMaster NCE-Fabric
Functions
Query subnets based on certain conditions.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/subnets

produc No string 0 to - Producer. This "default"

er 255 parameter is
charac optional. If it is
ters. specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
logicS No string 0 to - Subnet "DBB702C3-77

witchId 256 broadcast 19-4FE6-
charac domain. A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric

logicR No string 0 to - Logical router. "DBB702C3-77

outerId 6044 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309;DBB702
C3-7719-4FE6-
A5AD-3A9C9E2
65310"

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/subnets?producer=default&tenantId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&logicSwitchId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&logicRouterId=DBB702C3-7719-4FE6-A5AD-3A9C9E265309;DBB702C3-7719-4FE6-
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-908 SubnetPagedDtoWrapper parameters

eter t Value
subnet ARRAY For details, see Table Subnet -

ENCE

iMaster NCE-Fabric

eter t Value

um ] of subnets.

dex ]

ze ]
Table 1-909 QuerySubnetDto parameters

eter t Value
id string 0 to 256 - Object ID. This "DBB702C3-77

characters. field cannot be 19-4FE6-
65309"
logicS string 0 to 256 - Subnet "DBB702C3-77

witchId characters. broadcast 19-4FE6-
domain. A5AD-3A9C9E2
Reserved 65309"
parameter.
cidr string 1 to 255 - Subnet "192.168.1.0/24

characters. segment. This "
parameter
cannot be
updated if the
subnet is
associated with
a logical
switch.
gatew string 1 to 255 - Subnet "192.168.1.1"

ayIp characters. gateway IP
address. This
parameter is
optional when
Logical router
type is set to
Multi-active.
This field
cannot be
updated

iMaster NCE-Fabric

eter t Value
allocPo REFER For details, see Table Reserved -

ol ENCE 1-910. parameter.
reserve REFER For details, see Table Reserved -

Pool ENCE 1-911. parameter.
tenantI string 0 to 256 - Tenant. This "DBB702C3-77

updated. If a A5AD-3A9C9E2
new value is 65309"
entered during
the update, the
value used
during the
creation is
retained and is
not updated.

outerId characters. ID. This field is 19-4FE6-
mandatory A5AD-3A9C9E2
during the 65309"
creation and
optional during
the update.
This field
cannot be
updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.
device ARRAY For details, see Table Parameter -

Gatew _REFER 1-912. required when
router type is
Multi-active.
vrrpCo ARRAY For details, see Table Parameter -

nfig _REFER 1-913. required when
ENCE the logical
router type is
Multi-active.

iMaster NCE-Fabric

eter t Value

dhcpE boolea - false Whether to false

nable n enable DHCP.
dhcpGr string 0 to 256 - DHCP server "DBB702C3-77

oupId characters. group 19-4FE6-
associated with A5AD-3A9C9E2
the subnet. 65309"
Table 1-910 AllocPoolDto parameters

eter t Value
ipBegi string 1 to 255 - Start IP "192.168.1.1"

n characters. address.
ipEnd string 1 to 255 - End IP address. "192.168.1.2"

characters.
Table 1-911 ReservePoolDto parameters

eter t Value
ipBegi string 1 to 255 - Start IP "192.168.1.1"

n characters. address.
ipEnd string 1 to 255 - End IP address. "192.168.1.2"

characters.
Table 1-912 DeviceGroupGatewayIpDto parameters

eter t Value

GroupI characters. ID. This field 19-4FE6-
update 65309"

iMaster NCE-Fabric

eter t Value
gatew string - - Only IPv4 "192.168.1.1"

ayIp addresses are
supported. This
field can be
updated.
Table 1-913 DeviceGroupVrrpDto parameters

eter t Value

65309"

GroupI characters. ID. This field 19-4FE6-
update 65309"
vrrpVri string 1 to 255 - VRRP VRID. "10"

d characters. This field can
be updated.
virtualI string - - Only IPv4 "192.168.1.1"

p addresses are
supported. This
field can be
updated.
vrrpPri string 1 to 254 - Priority. This "10"

ority characters. field can be
updated.
preem boolea - - Whether to false

ptEnab n enable
le preemption.
This field can
be updated.
preem string 0 to 3600 - Preemption "10"

pt characters. time. This field
can be
updated.

iMaster NCE-Fabric

eter t Value
recover string 0 to 3600 - Delay before a "10"

yDelay characters. VRRP group
recovers. The
value can be
changed.

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

00"

00"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"subnet" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gatewayIp" : "192.168.1.1",
"allocPool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
"reservePool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
{
"gatewayIp" : "192.168.1.1"
}
],
"vrrpConfig" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vrrpVrid" : "10",
"virtualIp" : "192.168.1.1",
"preempt" : "10",
}
],
"additional" : {
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
},
"dhcpEnable" : false,
"dhcpGroupId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.2.3 Query a Subnet by ID
Typical Scenarios
A subnet needs to be queried by ID.

iMaster NCE-Fabric
Functions
Query a subnet by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/subnets/subnet/{id}


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/subnets/subnet/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-916 QuerySubnetDtoWapper parameters

eter t Value

ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"subnet" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gatewayIp" : "192.168.1.1",
"allocPool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
"reservePool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
{
"gatewayIp" : "192.168.1.1"
}
],
"vrrpConfig" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vrrpVrid" : "10",
"virtualIp" : "192.168.1.1",
"preempt" : "10",
}
],
"additional" : {
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"

iMaster NCE-Fabric
},
"dhcpEnable" : false,
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.2.4 Update a Subnet by ID
Typical Scenarios
A subnet needs to be updated by ID.
Functions
ID for updating a subnet.
Constraints
HTTP Method
PUT
URI


256 a subnet. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-900. s for
updating
a subnet.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/subnets/subnet/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"subnet" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gatewayIp" : "192.168.1.1",
"allocPool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
"reservePool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
{
"gatewayIp" : "192.168.1.1"
}
],
"vrrpConfig" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vrrpVrid" : "10",
"virtualIp" : "192.168.1.1",
"preempt" : "10",
}
],
"additional" : {
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}

iMaster NCE-Fabric
}
]
}
Response Parameters
Table 1-919 SubnetDtoWrapper parameters

eter t Value

ENCE

eter t Value

65309"
logicS string 0 to 256 - Subnet "DBB702C3-77

witchId characters. broadcast 19-4FE6-
domain. A5AD-3A9C9E2
Reserved 65309"
parameter.

characters. segment. This "
parameter
cannot be
updated if the
subnet is
associated with
a logical
switch.

iMaster NCE-Fabric

eter t Value

address. This
parameter is
optional when
Logical router
type is set to
Multi-active.
This field
cannot be
updated
allocPo REFER For details, see Table Reserved -

ol ENCE 1-910. parameter.
reserve REFER For details, see Table Reserved -

Pool ENCE 1-911. parameter.

updated. If a A5AD-3A9C9E2
new value is 65309"
entered during
the update, the
value used
during the
creation is
retained and is
not updated.

outerId characters. ID. This field is 19-4FE6-
mandatory A5AD-3A9C9E2
during the 65309"
creation and
optional during
the update.
This field
cannot be
updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.

iMaster NCE-Fabric

eter t Value
device ARRAY For details, see Table Parameter -

Gatew _REFER 1-912. required when
router type is
Multi-active.
vrrpCo ARRAY For details, see Table Parameter -

nfig _REFER 1-913. required when
ENCE the logical
router type is
Multi-active.

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"subnet" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gatewayIp" : "192.168.1.1",
"allocPool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
"reservePool" : {
"ipBegin" : "192.168.1.1",
"ipEnd" : "192.168.1.2"
},
{
"gatewayIp" : "192.168.1.1"
}
],
"vrrpConfig" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"vrrpVrid" : "10",
"virtualIp" : "192.168.1.1",
"preempt" : "10",
}
],
"additional" : {
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.2.5 Delete a Subnet by ID
Typical Scenarios
A subnet needs to be deleted by ID.
Functions
Delete a subnet by ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric

id Yes string 0 to - Subnet ID "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/subnets/subnet/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.3 Logical Switch Management

Logical API description:
1. Query information about all logical switches.
2. Create a logical switch.
3. Query all logical access switches.
4. Query a logical switch by ID.
5. Update a logical switch by ID.
6. Delete a logical switch by ID.
1.9.7.3.1 Create a Logical Switch
Typical Scenarios
A logical switch needs to be created.
Functions
Create a logical switch.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/switchs
Request Parameters

er Range Value on

NCE 1-923. s for
creating a
logical
switch.

iMaster NCE-Fabric
Table 1-923 LogicSwitchDtoWrapper parameters

switch Yes ARRAY For details, see Logical switch -

ENCE
Table 1-924 LogicSwitchDto parameters

id Yes string 36 - Object ID. This "DBB702C3-77

The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name Yes string 1 to - Object name. "name"

255 This field can
charac be updated.
ters.
descrip No string 0 to - Object "description"

charac This field can
ters. be updated.

iMaster NCE-Fabric

logicN Yes string 0 to - Logical "DBB702C3-77

etwork 256 network where 19-4FE6-
Id charac the logical A5AD-3A9C9E2
ters. switch is 65309"
located. This
field cannot be
updated.
vni No int32 [0-160 - Logical switch 10

00000] VNI. This field
cannot be
updated.
bd No int32 [0-160 - BD ID of a 10
00000] logical switch.
This field
cannot be
updated.
macAd No string [0-160 - MAC address "00:00:5E:

dress 00000] of a logical 00:01:01"
switch. This
field can be
updated.
tenantI No string 0 to - Tenant. This "DBB702C3-77

d 256 parameter can 19-4FE6-
charac be specified or A5AD-3A9C9E2
ters. not specified in 65309"
the
northbound
API. The
controller
automatically
obtains the
tenant ID from
the logical
network. The
value cannot
be changed.
tenant No string 0 to - Tenant name. "tenantName"

Name 255
charac
ters.
qosId No string 1 to 36 - QoS profile. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

arpBro No string - - Whether to "default"

adcast enable ARP
StormE broadcast
nable suppression.
The value can
be default,
enable, or
disable. The
value default
indicates that
the value is the
same as that
on the fabric.
arpL2P No boolea - false Whether to false

roxyEn n enable ARP
able gateway proxy
response.
subnet No array< 0-255 - Subnet set, -

s string> items. which is sorted
in sequence.
The first IPv4
subnet in the
array is the
primary IPv4
subnet.
hostInf No boolea - true Host false

oCollec n information
t collection. If
the value is
false, ARP
broadcast
suppression is
forcibly
disabled.
arpDir No boolea - - Whether the false

ectRou n IPv4 routing
teEnab policy
le generated by
VLINK routes is
enabled.

iMaster NCE-Fabric

ndDire No boolea - - Whether the false

ctRout n IPv6 routing
eEnabl policy
e generated by
VLINK routes is
enabled.
vlinkD No ARRAY 0-4500 items. Set of device -

eviceG _REFER For details, see groups where
roups ENCE Table 1-925. VLINK is
enabled. The
VBDIF interface
of the logical
switch in the
selected device
group delivers
IPv4 or IPv6
VLINK
configurations
on demand.
The device
group is from
the fabric of
the VPC to
which the
logical switch
belongs. This
field cannot be
configured
together with
arpDirectRoute
Enable or
ndDirectRouteE
nable.
macRo No boolea - false MAC route false

uteSup n suppression.
press

stormS No REFER For details, see Storm -

uppres ENCE Table 1-927. suppression
s information
about the
logical switch.

iMaster NCE-Fabric
Table 1-925 VlinkDeviceGroupDto parameters

device Yes string 0 to - Device group "DBB702C3-77

ters. 65309"
device No string 0 to - Device group "deviceGroup1"

Group 256 name.
Name charac
ters.


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 16:30:40"
charac
ters.

At 255 16:30:40"
charac
ters.

iMaster NCE-Fabric
Table 1-927 SwitchStormSuppressDto parameters

broadc No boolea - false Whether to false

astEna n enable the
ble broadcast
function. This
field can be
updated.
multic No boolea - false Whether to false

astEna n enable the
ble multicast
function. This
field can be
updated.
unicast No boolea - false Whether to false

Enable n enable the
unicast
function. This
field can be
updated.
broadc No string 0 to 10000 CBS of "10000"

astCbs 255 broadcast
charac packets. If the
ters. unit is in bytes,
the value
ranges from
10000 to
4294967295. If
the unit is in
kbytes, the
value ranges
from 9 to
4194303. If the
unit is in
mbytes, the
value ranges
from 1 to 4095.
The value can
be changed.

iMaster NCE-Fabric

broadc No string 0 to byte CBS unit of "byte"

astCbs 255 broadcast
Unit charac packets. The
ters. value can be
bytes, Kbytes,
or Mbytes. This
field can be
updated.
broadc No int64 [0-429 100 Broadcast CIR. 100

astCir 49672 The value
95] range is from 0
to 4294967295
in kbit/s, 0 to
4294967 in
Mbit/s, or 0 to
4294 in Gbit/s.
This field can
be updated.
broadc No string 0 to kbps CIR unit of "kbps"

astCirU 255 broadcast
nit charac packets. The
ters. value can be
Gbit/s, Mbit/s,
or kbit/s. This
field can be
updated.
unicast No string 0 to 10000 CBS of unicast "10000"

Cbs 255 packets. The
charac value range is
ters. from 10000 to
4294967295 in
bytes, 9 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes. This
field can be
updated.

iMaster NCE-Fabric

unicast No string 0 to byte CBS unit of "byte"

CbsUni 255 unicast
t charac packets. The
ters. value can be
bytes, Kbytes,
or Mbytes. This
field can be
updated.
unicast No int64 [0-429 100 Unicast CIR. 100

Cir 49672 The value
95] range is from 0
to 4294967295
in kbit/s, 0 to
4294967 in
Mbit/s, or 0 to
4294 in Gbit/s.
This field can
be updated.
unicast No string 0 to kbps CIR unit of "kbps"

CirUnit 255 unicast
charac packets. The
ters. value can be
Gbit/s, Mbit/s,
or kbit/s. This
field can be
updated.
multic No string 0 to 10000 CBS of "10000"

astCbs 255 multicast
charac packets. The
ters. value range is
from 10000 to
4294967295 in
bytes, 9 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes. This
field can be
updated.

iMaster NCE-Fabric

multic No string 0 to byte CBS unit of "byte"

astCbs 255 multicast
Unit charac packets. The
ters. value can be
bytes, Kbytes,
or Mbytes. This
field can be
updated.
multic No int64 [0-429 100 Multicast CIR. 100

astCir 49672 The value
95] range is from 0
to 4294967295
in kbit/s, 0 to
4294967 in
Mbit/s, or 0 to
4294 in Gbit/s.
This field can
be updated.
multic No string 0 to kbps CIR unit of "kbps"

astCirU 255 multicast
nit charac packets. The
ters. value can be
Gbit/s, Mbit/s,
or kbit/s. This
field can be
updated.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/switchs HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"switch" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"logicNetworkId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vni" : 10,
"bd" : 10,
"macAddress" : "00:00:5E:00:01:01",
"tenantName" : "tenantName",
"qosId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"arpBroadcastStormEnable" : "default",
"arpL2ProxyEnable" : false,
"subnets" : [
"192.168.10.1/24"
],
"hostInfoCollect" : false,
"arpDirectRouteEnable" : false,
"ndDirectRouteEnable" : false,
"vlinkDeviceGroups" : [
{
"deviceGroupName" : "deviceGroup1"
}
],
"macRouteSuppress" : false,
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"stormSuppress" : {
"broadcastEnable" : false,
"multicastEnable" : false,
"unicastEnable" : false,
"broadcastCbs" : "10000",
"broadcastCbsUnit" : "byte",
"broadcastCir" : 100,
"broadcastCirUnit" : "kbps",
"unicastCbs" : "10000",
"unicastCbsUnit" : "byte",
"unicastCir" : 100,
"unicastCirUnit" : "kbps",
"multicastCbs" : "10000",
"multicastCbsUnit" : "byte",
"multicastCir" : 100,
"multicastCirUnit" : "kbps"
}
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.3.2 Query Logical Switches
Typical Scenarios
Logical switches need to be queried.
Functions
Query all logical switches.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/switchs


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric

logicN No string 0 to - ID of the "DBB702C3-77

etwork 256 logical network 19-4FE6-
Id charac where a logical A5AD-3A9C9E2
ters. switch is 65309"
located.
logicS No string - - Logical switch "logicSwitchNa

witchN name. me"
ame

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/switchs?producer=default&tenantId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&logicNetworkId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&logicSwitchName=logicSwitchName&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-929 LogicSwitchPagedDtoWrapper parameters

eter t Value
switch ARRAY For details, see Table Logical switch -

ENCE

iMaster NCE-Fabric

eter t Value

um ] of switches.

dex ]

ze ]
Table 1-930 QueryLogicSwitchDto parameters

eter t Value
id string 36 characters. - Object ID. This "DBB702C3-77

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - Object name. "name"

characters. This field can
be updated.
descrip string 0 to 255 - Object "description"

This field can
be updated.
logicN string 0 to 256 - Logical "DBB702C3-77

etwork characters. network where 19-4FE6-
Id the logical A5AD-3A9C9E2
switch is 65309"
located. This
field cannot be
updated.
vni int32 [0-16000000] - Logical switch 10

VNI. This field
cannot be
updated.

iMaster NCE-Fabric

eter t Value
bd int32 [0-16000000] - BD ID of a 10
logical switch.
This field
cannot be
updated.
macAd string [0-16000000] - MAC address "00:00:5E:

dress of a logical 00:01:01"
switch. This
field can be
updated.

d characters. parameter can 19-4FE6-
be specified or A5AD-3A9C9E2
not specified in 65309"
the
northbound
API. The
controller
automatically
obtains the
tenant ID from
the logical
network. The
value cannot
be changed.
tenant string 0 to 255 - Tenant name. "tenantName"

Name characters.
qosId string 1 to 36 - QoS profile. "DBB702C3-77

A5AD-3A9C9E2
65309"
arpBro string - - Whether to "default"

adcast enable ARP
StormE broadcast
nable suppression.
The value can
be default,
enable, or
disable. The
value default
indicates that
the value is the
same as that
on the fabric.

iMaster NCE-Fabric

eter t Value
arpL2P boolea - false Whether to false

roxyEn n enable ARP
able gateway proxy
response.
subnet array< 0-255 items. - Subnet set, -

s string> which is sorted
in sequence.
The first IPv4
subnet in the
array is the
primary IPv4
subnet.
hostInf boolea - true Host false

t collection. If
the value is
false, ARP
broadcast
suppression is
forcibly
disabled.
arpDir boolea - - Whether the false

teEnab policy
le generated by
VLINK routes is
enabled.
ndDire boolea - - Whether the false

eEnabl policy
e generated by
VLINK routes is
enabled.

iMaster NCE-Fabric

eter t Value
vlinkD ARRAY 0-4500 items. For details, Set of device -

eviceG _REFER see Table 1-931. groups where
roups ENCE VLINK is
enabled. The
VBDIF interface
of the logical
switch in the
selected device
group delivers
IPv4 or IPv6
VLINK
configurations
on demand.
The device
group is from
the fabric of
the VPC to
which the
logical switch
belongs. This
field cannot be
configured
together with
arpDirectRoute
Enable or
ndDirectRouteE
nable.
macRo boolea - false MAC route false

press

stormS REFER For details, see Table Storm -

uppres ENCE 1-933. suppression
s information
about the
logical switch.
import array< 0-255 items. - Import RT of 10

RouteT string> the BGP EVPN
argets on a logical
switch. The
value is a
string.

iMaster NCE-Fabric

eter t Value
export array< 0-255 items. - Export RT of 10

argets a logical
switch. The
value is a
string.
qosTe string 0 to 256 - QoS template "DBB702C3-77

mplate characters. ID. 19-4FE6-
Id A5AD-3A9C9E2
65309"
Table 1-931 VlinkDeviceGroupDto parameters

eter t Value

d A5AD-3A9C9E2
65309"
device string 0 to 256 - Device group "deviceGroup1"

Group characters. name.
Name

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

iMaster NCE-Fabric

eter t Value


Table 1-933 SwitchStormSuppressDto parameters

eter t Value
broadc boolea - false Whether to false

astEna n enable the
ble broadcast
function. This
field can be
updated.
multic boolea - false Whether to false

astEna n enable the
ble multicast
function. This
field can be
updated.
unicast boolea - false Whether to false

Enable n enable the
unicast
function. This
field can be
updated.

iMaster NCE-Fabric

eter t Value
broadc string 0 to 255 10000 CBS of "10000"

astCbs characters. broadcast
packets. If the
unit is in bytes,
the value
ranges from
10000 to
4294967295. If
the unit is in
kbytes, the
value ranges
from 9 to
4194303. If the
unit is in
mbytes, the
value ranges
from 1 to 4095.
The value can
be changed.
broadc string 0 to 255 byte CBS unit of "byte"

astCbs characters. broadcast
Unit packets. The
value can be
bytes, Kbytes,
or Mbytes. This
field can be
updated.
broadc int64 [0-4294967295 100 Broadcast CIR. 100

astCir ] The value
range is from 0
to 4294967295
in kbit/s, 0 to
4294967 in
Mbit/s, or 0 to
4294 in Gbit/s.
This field can
be updated.
broadc string 0 to 255 kbps CIR unit of "kbps"

astCirU characters. broadcast
nit packets. The
value can be
Gbit/s, Mbit/s,
or kbit/s. This
field can be
updated.

iMaster NCE-Fabric

eter t Value
unicast string 0 to 255 10000 CBS of unicast "10000"

Cbs characters. packets. The
value range is
from 10000 to
4294967295 in
bytes, 9 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes. This
field can be
updated.
unicast string 0 to 255 byte CBS unit of "byte"

CbsUni characters. unicast
t packets. The
value can be
bytes, Kbytes,
or Mbytes. This
field can be
updated.
unicast int64 [0-4294967295 100 Unicast CIR. 100

Cir ] The value
range is from 0
to 4294967295
in kbit/s, 0 to
4294967 in
Mbit/s, or 0 to
4294 in Gbit/s.
This field can
be updated.
unicast string 0 to 255 kbps CIR unit of "kbps"

CirUnit characters. unicast
packets. The
value can be
Gbit/s, Mbit/s,
or kbit/s. This
field can be
updated.

iMaster NCE-Fabric

eter t Value
multic string 0 to 255 10000 CBS of "10000"

astCbs characters. multicast
packets. The
value range is
from 10000 to
4294967295 in
bytes, 9 to
4194303 in
Kbytes, or 1 to
4095 in
Mbytes. This
field can be
updated.
multic string 0 to 255 byte CBS unit of "byte"

astCbs characters. multicast
Unit packets. The
value can be
bytes, Kbytes,
or Mbytes. This
field can be
updated.
multic int64 [0-4294967295 100 Multicast CIR. 100

astCir ] The value
range is from 0
to 4294967295
in kbit/s, 0 to
4294967 in
Mbit/s, or 0 to
4294 in Gbit/s.
This field can
be updated.
multic string 0 to 255 kbps CIR unit of "kbps"

astCirU characters. multicast
nit packets. The
value can be
Gbit/s, Mbit/s,
or kbit/s. This
field can be
updated.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"switch" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"vni" : 10,
"bd" : 10,
"macAddress" : "00:00:5E:00:01:01",
"subnets" : [
"192.168.10.1/24"
],
{
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"stormSuppress" : {
"unicastCir" : 100,
},
"importRouteTargets" : 10,
"exportRouteTargets" : 10,
"qosTemplateId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.3.3 Query Information About All Logical Access Switches
Typical Scenarios
All logical access switches need to be queried.
Functions
Query all logical access switches and fabric information about VPCs to which the
switches belong based on specified conditions.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/switchs/access-switch

name No string - - Logical switch "logicSwitchNa

name. Fuzzy me"
match is
supported.
fabricI No string - - Fabric list. "DBB702C3-77

ds 19-4FE6-
A5AD-3A9C9E2
65309"

dex 255
charac
ters.

iMaster NCE-Fabric


ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/switchs/access-switch?
name=logicSwitchName&fabricIds=DBB702C3-7719-4FE6-A5AD-3A9C9E265309&pageIndex=1&pageSize=1
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-935 AccessSwitchInfoDtoWrapper parameters

eter t Value

um ] of switches.
pageIn string 1 to - Page index. "1"

dex 2147483647
characters.
pageSi string 1 to - Page size. "1"

ze 2147483647
characters.
access ARRAY For details, see Table Permission -

Switch _REFER 1-936. information.
ENCE

iMaster NCE-Fabric
Table 1-936 AccessSwitchDto parameters

eter t Value

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

be updated.

This field can
be updated.

switch is 65309"
located. This
field cannot be
updated.

VNI. This field
cannot be
updated.
bd int32 [0-16000000] - BD ID of a 10
logical switch.
This field
cannot be
updated.

switch. This
field can be
updated.

iMaster NCE-Fabric

eter t Value

the
northbound
API. The
controller
automatically
obtains the
tenant ID from
the logical
network. The
value cannot
be changed.

Name characters.

A5AD-3A9C9E2
65309"

adcast enable ARP
StormE broadcast
nable suppression.
The value can
be default,
enable, or
disable. The
value default
indicates that
the value is the
same as that
on the fabric.

roxyEn n enable ARP
able gateway proxy
response.

iMaster NCE-Fabric

eter t Value

in sequence.
The first IPv4
subnet in the
array is the
primary IPv4
subnet.

t collection. If
the value is
false, ARP
broadcast
suppression is
forcibly
disabled.

teEnab policy
le generated by
VLINK routes is
enabled.

eEnabl policy
e generated by
VLINK routes is
enabled.

iMaster NCE-Fabric

eter t Value

roups ENCE VLINK is
enabled. The
VBDIF interface
of the logical
switch in the
selected device
group delivers
IPv4 or IPv6
VLINK
configurations
on demand.
The device
group is from
the fabric of
the VPC to
which the
logical switch
belongs. This
field cannot be
configured
together with
arpDirectRoute
Enable or
ndDirectRouteE
nable.

press


s information
about the
logical switch.
import array< 0-255 items. - Import RT of 10

argets on a logical
switch. The
value is a
string.

iMaster NCE-Fabric

eter t Value
export array< 0-255 items. - Export RT of 10

argets a logical
switch. The
value is a
string.
qosTe string 0 to 256 - QoS template "DBB702C3-77

mplate characters. ID. 19-4FE6-
Id A5AD-3A9C9E2
65309"
fabricI array< 0-255 items. - Fabric IDs after ["DBB702C3-7

ds string> filtering. 719-4FE6-
A5AD-3A9C9E2
65309"]
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"totalNum" : 200,
"pageIndex" : "1",
"pageSize" : "1",
"accessSwitch" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"vni" : 10,
"bd" : 10,
"macAddress" : "00:00:5E:00:01:01",
"subnets" : [
"192.168.10.1/24"
],

iMaster NCE-Fabric
{
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"stormSuppress" : {
"unicastCir" : 100,
},
"qosTemplateId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"fabricIds" : ["DBB702C3-7719-4FE6-A5AD-3A9C9E265309"]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.3.4 Query a Logical Switch by ID
Typical Scenarios
A logical switch needs to be queried by ID.
Functions
Query a logical switch by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/switchs/switch/{id}


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/switchs/switch/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-938 QueryLogicSwitchDtoWrapper parameters

eter t Value

ENCE

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"switch" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"vni" : 10,
"bd" : 10,
"macAddress" : "00:00:5E:00:01:01",
"subnets" : [
"192.168.10.1/24"
],
{
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"stormSuppress" : {
"unicastCir" : 100,
},
"qosTemplateId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
]
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.3.5 Update a Logical Switch by ID
Typical Scenarios
A logical switch needs to be updated by ID.
Functions
ID for updating a logical switch.
Constraints
HTTP Method
PUT
URI


charac switch. A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-923. s for
updating
a logical
switch.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/switchs/switch/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"switch" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"vni" : 10,
"bd" : 10,
"macAddress" : "00:00:5E:00:01:01",
"subnets" : [
"192.168.10.1/24"
],
{
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"stormSuppress" : {

iMaster NCE-Fabric
"unicastCir" : 100,
}
}
]
}
Response Parameters

eter t Value

ENCE

eter t Value

following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

be updated.

This field can
be updated.

iMaster NCE-Fabric

eter t Value

switch is 65309"
located. This
field cannot be
updated.

VNI. This field
cannot be
updated.
bd int32 [0-16000000] - BD ID of a 10
logical switch.
This field
cannot be
updated.

switch. This
field can be
updated.

the
northbound
API. The
controller
automatically
obtains the
tenant ID from
the logical
network. The
value cannot
be changed.

Name characters.

A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value

adcast enable ARP
StormE broadcast
nable suppression.
The value can
be default,
enable, or
disable. The
value default
indicates that
the value is the
same as that
on the fabric.

roxyEn n enable ARP
able gateway proxy
response.

in sequence.
The first IPv4
subnet in the
array is the
primary IPv4
subnet.

t collection. If
the value is
false, ARP
broadcast
suppression is
forcibly
disabled.

teEnab policy
le generated by
VLINK routes is
enabled.

iMaster NCE-Fabric

eter t Value

eEnabl policy
e generated by
VLINK routes is
enabled.

roups ENCE VLINK is
enabled. The
VBDIF interface
of the logical
switch in the
selected device
group delivers
IPv4 or IPv6
VLINK
configurations
on demand.
The device
group is from
the fabric of
the VPC to
which the
logical switch
belongs. This
field cannot be
configured
together with
arpDirectRoute
Enable or
ndDirectRouteE
nable.

press


s information
about the
logical switch.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"switch" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"vni" : 10,
"bd" : 10,
"macAddress" : "00:00:5E:00:01:01",
"subnets" : [
"192.168.10.1/24"
],
{
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"stormSuppress" : {
"unicastCir" : 100,
}
}
]
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.3.6 Delete a Logical Switch by ID
Typical Scenarios
A logical switch needs to be deleted by ID.
Functions
Delete a logical switch by ID.
Constraints
HTTP Method
DELETE
URI


charac switch. A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/switchs/switch/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.4 Logical Port Management

APIs for adding, deleting, updating, and querying logical ports
1.9.7.4.1 Logical Port Management
Typical Scenarios
A logical port needs to be created.
Functions
Create a logical port.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/ports
Request Parameters

er Range Value on

NCE 1-945. port
configurat
ion.

port Yes ARRAY For details, see Logical port -

_REFER Table 1-946. information
ENCE


ters. 65309"
name Yes string 1 to - Object name. "logicPortNam

255 This field can e"
charac be updated.
ters.
qosId No string 0 to - QoS profile. "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric


charac This field can
ters. be updated.
unshar No boolea - false Non-shared false

ePortV n VLAN.
lan
status No string 1 to - Port status. The "up"

255 value can be
charac up or down.
ters.
logicS Yes string 0 to - Logical switch "DBB702C3-77

witchId 256 to which a 19-4FE6-
charac logical port A5AD-3A9C9E2
ters. belongs. This 65309"
field cannot be
updated.
logicS No string 1 to - Name of the "logicSwitchNa

witchN 255 logical switch me"
ame charac to which the
ters. logical port
belongs.
metaD No string - - Metadata "metaData"

ata information of
a logical port.
This parameter
is reserved.
accessI Yes REFER For details, see Additional -

nfo ENCE Table 1-947. information.
tenantI No string 0 to - Tenant ID. This "DBB702C3-77

d 256 parameter is 19-4FE6-
charac automatically A5AD-3A9C9E2
ters. obtained by 65309"
the controller.
This field
cannot be
updated.


iMaster NCE-Fabric

fabricI No string 0 to - Fabric to which "DBB702C3-77

d 256 the logical port 19-4FE6-
charac belongs. This A5AD-3A9C9E2
modified.
Table 1-947 AccessInfoDto parameters

mode Yes string 1 to UNI Port mode, "UNI"

255 which can be
charac UNI or NNI.
ters. This field
cannot be
updated.
type Yes string 1 to DOT1Q Logical port "DOT1Q"

255 type, which can
charac be DOT1Q,
ters. DEFAULT,
UNTAG, or
QINQ. This
field cannot be
updated.
vlan No int32 [2-409 - Access VLAN 10

4] ID. This
parameter is
mandatory
when the
access type is
dot1q. This
field can be
updated.
qinq No REFER For details, see QinQ -

locatio Yes ARRAY For details, see Device port -

n _REFER Table 1-949. information.
ENCE

iMaster NCE-Fabric

subint No int32 [1-409 - Number of an 10

erface 4] access sub-
Numb interface. This
er field cannot be
modified.
Table 1-948 QinqDto parameters

innerVi Yes int32 [2-409 - Start VLAN ID 10

dBegin 4] of the inner
VLAN tag for
QinQ. This field
can be
updated.
innerVi No int32 [2-409 - End VLAN ID 10

dEnd 4] of the inner
VLAN tag for
QinQ. This field
can be
updated.
outerV Yes int32 [2-409 - Start VLAN ID 10

idBegi 4] of the outer
n VLAN tag for
QinQ. This field
can be
updated.
outerV No int32 [2-409 - End VLAN ID 10

idEnd 4] of the outer
VLAN tag for
QinQ. This field
can be
updated.
rewrite Yes string 1 to POPDO Rewrite action "POPDOUBLE"

Action 255 UBLE of QinQ. The
charac value can be
ters. POPDOUBLE or
PASSTHROUG
H. The value
cannot be
changed.

iMaster NCE-Fabric


GroupI 256 ID of a physical 19-4FE6-
d charac device. This A5AD-3A9C9E2
updated.
device No string 1 to - Device group "CE_45"

Group 255 name of a
Name charac physical device.
ters. The value
cannot be
changed.
deviceI No string 0 to - Specified "DBB702C3-77

d 256 physical device. 19-4FE6-
charac Either the A5AD-3A9C9E2
ters. device ID or 65309"
device
management
IP address can
be set. This
field cannot be
updated.
device No string 1 to - Name of a "CE_45"

Name 255 physical device.
charac The value
ters. cannot be
changed.
portId No string 0 to - Specified "DBB702C3-77

256 physical port. 19-4FE6-
charac Either the port A5AD-3A9C9E2
ters. ID or port 65309"
name can be
set. This field
cannot be
updated
portNa No string 0 to - Port name. "10GE1/0/1"

me 255 Either the port
charac ID or port
ters. name can be
set. This field
cannot be
updated.

iMaster NCE-Fabric

deviceI No string 0 to - Device "192.168.1.1"

p 255 management
charac IP address.
ters. Either the
device ID or
the device
management
ID can be set.
This field
cannot be
updated.


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 16:30:40"
charac
ters.

At 255 16:30:40"
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/ports HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
{
"port" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "logicPortName",
"unsharePortVlan" : false,
"status" : "up",
"logicSwitchName" : "logicSwitchName",
"metaData" : "metaData",
"accessInfo" : {
"mode" : "UNI",
"type" : "DOT1Q",
"vlan" : 10,
"qinq" : {
"innerVidBegin" : 10,
"innerVidEnd" : 10,
"outerVidBegin" : 10,
"outerVidEnd" : 10,
"rewriteAction" : "POPDOUBLE"
},
"location" : [
{
"deviceGroupName" : "CE_45",
"deviceIp" : "192.168.1.1"
}
],
"subinterfaceNumber" : 10
},
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"fabricId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
]
}
Response Parameters
Sample Response

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.4.2 Query All Logical Ports
Typical Scenarios
All logical ports need to be queried.
Functions
Query all logical ports.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/ports

iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
logicS No string 0 to - Logical switch "DBB702C3-77

witchId 256 to which a 19-4FE6-
charac logical port A5AD-3A9C9E2
ters. belongs. 65309"

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/ports?producer=default&logicSwitchId=DBB702C3-7719-4FE6-
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-952 PortPagedDtoWrapper parameters

eter t Value
port ARRAY For details, see Table Logical port -

ENCE

um ] of logical ports.

dex ]

ze ]

eter t Value

65309"
name string 1 to 255 - Object name. "logicPortNam

characters. This field can e"
be updated.

A5AD-3A9C9E2
65309"

This field can
be updated.
unshar boolea - false Non-shared false

ePortV n VLAN.
lan
status string 1 to 255 - Port status. The "up"

characters. value can be
up or down.

iMaster NCE-Fabric

eter t Value
logicS string 0 to 256 - Logical switch "DBB702C3-77

witchId characters. to which a 19-4FE6-
logical port A5AD-3A9C9E2
belongs. This 65309"
field cannot be
updated.
logicS string 1 to 255 - Name of the "logicSwitchNa

witchN characters. logical switch me"
ame to which the
logical port
belongs.
metaD string - - Metadata "metaData"

ata information of
a logical port.
This parameter
is reserved.
accessI REFER For details, see Table Additional -

tenantI string 0 to 256 - Tenant ID. This "DBB702C3-77

d characters. parameter is 19-4FE6-
obtained by 65309"
the controller.
This field
cannot be
updated.

fabricI string 0 to 256 - Fabric to which "DBB702C3-77

d characters. the logical port 19-4FE6-
belongs. This A5AD-3A9C9E2
field cannot be 65309"
modified.

iMaster NCE-Fabric
Table 1-954 AccessInfoDto parameters

eter t Value
mode string 1 to 255 UNI Port mode, "UNI"

characters. which can be
UNI or NNI.
This field
cannot be
updated.
type string 1 to 255 DOT1Q Logical port "DOT1Q"

characters. type, which can
be DOT1Q,
DEFAULT,
UNTAG, or
QINQ. This
field cannot be
updated.
vlan int32 [2-4094] - Access VLAN 10

ID. This
parameter is
mandatory
when the
access type is
dot1q. This
field can be
updated.
qinq REFER For details, see Table QinQ -

locatio ARRAY For details, see Table Device port -

n _REFER 1-956. information.
ENCE
subint int32 [1-4094] - Number of an 10

erface access sub-
Numb interface. This
er field cannot be
modified.

iMaster NCE-Fabric
Table 1-955 QinqDto parameters

eter t Value
innerVi int32 [2-4094] - Start VLAN ID 10

dBegin of the inner
VLAN tag for
QinQ. This field
can be
updated.
innerVi int32 [2-4094] - End VLAN ID 10

dEnd of the inner
VLAN tag for
QinQ. This field
can be
updated.
outerV int32 [2-4094] - Start VLAN ID 10

idBegi of the outer
n VLAN tag for
QinQ. This field
can be
updated.
outerV int32 [2-4094] - End VLAN ID 10

idEnd of the outer
VLAN tag for
QinQ. This field
can be
updated.
rewrite string 1 to 255 POPDO Rewrite action "POPDOUBLE"

Action characters. UBLE of QinQ. The
value can be
POPDOUBLE or
PASSTHROUG
H. The value
cannot be
changed.

iMaster NCE-Fabric

eter t Value

GroupI characters. ID of a physical 19-4FE6-
d device. This A5AD-3A9C9E2
field cannot be 65309"
updated.
device string 1 to 255 - Device group "CE_45"

Group characters. name of a
Name physical device.
The value
cannot be
changed.
deviceI string 0 to 256 - Specified "DBB702C3-77

d characters. physical device. 19-4FE6-
Either the A5AD-3A9C9E2
device ID or 65309"
device
management
IP address can
be set. This
field cannot be
updated.
device string 1 to 255 - Name of a "CE_45"

Name characters. physical device.
The value
cannot be
changed.
portId string 0 to 256 - Specified "DBB702C3-77

characters. physical port. 19-4FE6-
Either the port A5AD-3A9C9E2
ID or port 65309"
name can be
set. This field
cannot be
updated

me characters. Either the port
ID or port
name can be
set. This field
cannot be
updated.

iMaster NCE-Fabric

eter t Value
deviceI string 0 to 255 - Device "192.168.1.1"

p characters. management
IP address.
Either the
device ID or
the device
management
ID can be set.
This field
cannot be
updated.

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.


Sample Response

iMaster NCE-Fabric
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"status" : "up",
"accessInfo" : {
"mode" : "UNI",
"type" : "DOT1Q",
"vlan" : 10,
"qinq" : {
"innerVidEnd" : 10,
"outerVidEnd" : 10,
},
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
},
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.4.3 Query Logical Port Information Based on the End Port ID List
Typical Scenarios
Logical port information needs to be queried based on the user port ID list.
Functions
The list of specified logical ports needs to be queried.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/ports/endport-ids
Request Parameters

er Range Value on
input REFERE For details, see Table End port -

NCE 1-959. ID list
used for
query.
Table 1-959 queryLogicPortByEndPortIdsDtoWrapper parameters

endPor Yes array< Each - End port ID list. -

tIds string> item
has 0
to 256
charac
ters.
pageIn No int32 [1-214 - Page index. 1

dex 74836
47]

iMaster NCE-Fabric

pageSi No int32 [1-214 - Page size. 1

ze 74836
47]
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/ports/endport-ids HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"endPortIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"pageIndex" : 1,
"pageSize" : 1
}
Response Parameters
PortPagedDtoWrapper parameters, For details, see Table 1-952.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"status" : "up",
"accessInfo" : {
"mode" : "UNI",

iMaster NCE-Fabric
"type" : "DOT1Q",
"vlan" : 10,
"qinq" : {
"innerVidEnd" : 10,
"outerVidEnd" : 10,
},
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
},
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.4.4 Query a Logical Port by ID
Typical Scenarios
A logical port needs to be queried by ID.
Functions
Query a logical port by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/ports/port/{id}

id Yes string 0 to - ID for querying "DBB702C3-77

charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/ports/port/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

eter t Value
port ARRAY For details, see Table Logical port -

ENCE

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"status" : "up",
"accessInfo" : {
"mode" : "UNI",
"type" : "DOT1Q",
"vlan" : 10,
"qinq" : {
"innerVidEnd" : 10,
"outerVidEnd" : 10,
},
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
},
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.4.5 Update a Logical Port by ID
Typical Scenarios
Update a Logical Port by ID.
Functions
Update a logical port by ID.
Constraints
HTTP Method
PUT
URI


256 a DHCP group. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters

er Range Value on

NCE 1-945. port
configurat
ion.
Sample Request
HTTP

iMaster NCE-Fabric
PUT /controller/dc/v3/logicnetwork/ports/port/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"port" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"status" : "up",
"accessInfo" : {
"mode" : "UNI",
"type" : "DOT1Q",
"vlan" : 10,
"qinq" : {
"innerVidEnd" : 10,
"outerVidEnd" : 10,
},
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
},
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
}
]
}
Response Parameters
PortDtoWrapper parameters, For details, see Table 1-961.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"status" : "up",
"accessInfo" : {
"mode" : "UNI",
"type" : "DOT1Q",
"vlan" : 10,
"qinq" : {
"innerVidEnd" : 10,
"outerVidEnd" : 10,
},
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
},
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.4.6 Update a Logical Port by ID
Typical Scenarios
A logical port needs to be deleted by ID.
Functions
Delete a logical port by ID.
Constraints
HTTP Method
DELETE
URI


charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/ports/port/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.5 Logical Port Group Management

Logical port group API description:
1. Create, update, and delete a logical port group.
1.9.7.5.1 Create a Logical Port Group
Typical Scenarios
A logical port group needs to be created.
Functions
Create a logical port group.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/logicportgroups

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-966. port
group
informati
on.
Table 1-966 LogicPortGroupsWrapper parameters

logicPo No ARRAY For details, see Set of logical -

rtGrou _REFER Table 1-967. port group
ps ENCE information.

iMaster NCE-Fabric
Table 1-967 LogicPortGroupDto parameters

id No string 0 to 36 - Logical port "DBB702C3-77

charac group ID. 19-4FE6-
ters. A5AD-3A9C9E2
36 65301"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

logicS Yes string 0 to 36 - ID of the "DBB702C3-77

witchId charac logical switch 19-4FE6-
ters. to which a A5AD-3A9C9E2
36 logical port 65301"
charac belongs.
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
access No string 1 to Dot1q Access type. "Dot1q"

Type 255 The value can
charac be Untag,
ters. Dot1q, or
PvlanSeparate.

iMaster NCE-Fabric

vlan No array Item group. This
value parameter is
range: not required
[0-409 when the
4] access type is
Untag. This
parameter is
set to one
VLAN when
the access type
is Dot1q. This
parameter is
set to active
and standby
VLANs when
the access type
is
PvlanSeparate.

iMaster NCE-Fabric

portGr No string 0 to 36 - ID of the port "DBB702C3-77

oupId charac group 19-4FE6-
ters. associated with A5AD-3A9C9E2
36 a logical port 65301"
charac group. The port
ters. group ID is
The preferentially
value used.
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
portGr No string 1 to - Name of the "thePortGroup"

oupNa 128 port group
me charac associated with
ters. a logical port
group. The port
group ID is
preferentially
used.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/logicportgroups HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
{
"logicPortGroups" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265301",
"accessType" : "Dot1q",
"vlan" : [
10
],
}
]
}
Response Parameters
Table 1-968 LogicPortGroupsOutputWrapper parameters

eter t Value
reques string 0 to 36 - Request ID, "DBB702C3-77

tId characters. 36 which can be 19-4FE6-
characters. The used to query A5AD-3A9C9E2
value must southbound 6530e"
meet the operation logs.
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
taskIds array< 0-255 items. - List of task IDs. -

to 36
characters.
ids array< 0-255 items. - Set of logical -

string> Each item has 0 port group IDs.
to 36
characters.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"requestId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E26530e",
"taskIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E26530f"
],
"ids" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E26530f"
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.5.2 Update a Logical Port Group
Typical Scenarios
A logical port group needs to be updated.
Functions
Update a logical port group.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/logicportgroups/logicportgroup/{id}

iMaster NCE-Fabric

id Yes string 0 to 36 - ID, by which a "DBB702C3-77

charac logical port 19-4FE6-
ters. group is A5AD-3A9C9E2
36 updated. 65301"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters

er Range Value on

NCE 1-971. port
group
informati
on.

iMaster NCE-Fabric
Table 1-971 LogicPortGroupWrapper parameters

logicPo No REFER For details, see Logical port -

rtGrou ENCE Table 1-967. group
p information.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/logicportgroups/logicportgroup/DBB702C3-7719-4FE6-
A5AD-3A9C9E265301 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"logicPortGroup" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265301",
"vlan" : [
10
],
}
}
Response Parameters
Table 1-972 LogicPortGroupWrapper parameters

eter t Value
logicPo REFER For details, see Table Logical port -

rtGrou ENCE 1-973. group
p information.

iMaster NCE-Fabric
Table 1-973 LogicPortGroupDto parameters

eter t Value
id string 0 to 36 - Logical port "DBB702C3-77

characters. 36 group ID. 19-4FE6-
value must 65301"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
logicS string 0 to 36 - ID of the "DBB702C3-77

witchId characters. 36 logical switch 19-4FE6-
characters. The to which a A5AD-3A9C9E2
value must logical port 65301"
meet the belongs.
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
access string 1 to 255 Dot1q Access type. "Dot1q"

Type characters. The value can
be Untag,
Dot1q, or
PvlanSeparate.

iMaster NCE-Fabric

eter t Value
vlan array [0-4094] group. This
parameter is
not required
when the
access type is
Untag. This
parameter is
set to one
VLAN when
the access type
is Dot1q. This
parameter is
set to active
and standby
VLANs when
the access type
is
PvlanSeparate.
portGr string 0 to 36 - ID of the port "DBB702C3-77

oupId characters. 36 group 19-4FE6-
characters. The associated with A5AD-3A9C9E2
value must a logical port 65301"
meet the group. The port
following group ID is
regular preferentially
expression: used.
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
portGr string 1 to 128 - Name of the "thePortGroup"

oupNa characters. port group
me associated with
a logical port
group. The port
group ID is
preferentially
used.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"logicPortGroup" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265301",
"vlan" : [
10
],
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.5.3 Delete a Logical Port Group
Typical Scenarios
A logical port group needs to be deleted.
Functions
Delete a logical port group.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/logicportgroup/batchdelete

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table Set of -

NCE 1-975. logical
port
group IDs.
Table 1-975 LogicPortGroupIdsWrapper parameters

ids No array< 0-255 - Set of logical -

string> items. port group IDs.
Each
item
has 0
to 36
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/logicportgroup/batchdelete HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"ids" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265301"
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6 Logical Router Management

Logical router management API description:
1. Query the logical router list.
2. Create a logical router.
3. Query a logical router by ID.
4. Update a logical router by ID.
5. Delete a logical router by ID.
6. Configure the route of a logical router.
7. Delete the route of a logical router.
8. Configure BGP for a logical router.
9. Delete BGP of a logical router.
10. Switch active and standby fabrics of logical routers in batches.
1.9.7.6.1 Create a Logical Router
Typical Scenarios
A logical router needs to be created.
Functions
Create a logical router.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/routers
Request Parameters

wrapp Yes REFER For details, see Input -

er ENCE Table 1-977. parameters for
creating a
logical router.
Table 1-977 LogicRouterDtoWrapper parameters

router Yes REFER For details, see Logical router -


iMaster NCE-Fabric
Table 1-978 LogicRoutersDto parameters

id Yes string 36 - Logical router "DBB702C3-77

charac ID. This field 19-4FE6-
The updated. 65311"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 1 to - Logical router "logicRouterNa

255 name. me"
charac
ters.
descrip No string 0 to - Description. "description"

tion 255
charac
ters.
qosId No string 0 to - QoS profile. "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
logicN No string 0 to - Logical "DBB702C3-77

ters. router is 65309"
located.

iMaster NCE-Fabric

routerL No ARRAY For details, see Router location -

ocatio _REFER Table 1-979. information.
ns ENCE When type is
set to Transit
or Connect,
this field
cannot be set.
Otherwise, this
field is
mandatory.
This field is
optional during
the update.
type No string 0 to - Logical router "Normal"

255 type. The value
charac can be Normal,
ters. Nfvi,
MultiActive,
Transit, or
Connect. This
field cannot be
updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.
vni No int32 [1-160 - Online/offline 10

00000] status of a
device. The
value cannot
be changed.
vrfNa No string 1 to 31 - VRF name. This "vrfName"

me charac field cannot be
ters. updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.

iMaster NCE-Fabric

connec No string 0 to - Interconnection "Nfvi"

tMode 255 mode. The
charac value is of the
ters. enumerated
type and can
be south-north,
east-west, all-
static, or
external-
gateway-group.
extern No array< - - Address ["192.168.1.0/2

alCidr string> accessible to 4"]
the connected
VPC through
the transit
router.
interna No array< - - This parameter ["192.168.2.0/2

lCidr string> is required only 4"]
when the
transit router
needs to
connect to an
external
gateway or
another transit
router. It
defines the
access egress
of the transit
router.
maxLo No int32 [1-128 - Number of 10

adBala ] load-balancing
nce routes. The
priority of this
field is higher
than that of
the global
configuration.


iMaster NCE-Fabric
Table 1-979 RouterLocationDto parameters


ters. 65309"
fabricR No string - - Fabric role. The "master"

ole value can be
master or
backup. This
parameter
cannot be
updated.

Name 255 This field
charac cannot be
ters. updated.

Group _REFER Table 1-980. Devices in the
ENCE list must
belong to the
same device
group. If the
logical router
type is Normal,
the value of
this parameter
must be null.

iMaster NCE-Fabric


d 256 Either the 19-4FE6-
charac device group A5AD-3A9C9E2
ters. ID or the 65309"
device
management
IP address
must be
specified. If a
device group is
selected, enter
only one device
ID. Only the
egress gateway
is displayed for
the query.

p 255 management
charac IP address.
ters. Either the
device group
ID or the
device
management
IP address
must be
specified. If a
device group is
selected, enter
only one device
ID. Only the
egress gateway
is displayed for
the query.

iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 16:30:40"
charac
ters.

At 255 16:30:40"
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/routers HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265311",
"name" : "logicRouterName",
"routerLocations" : [
{
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"

iMaster NCE-Fabric
}
]
}
],
"type" : "Normal",
"vni" : 10,
"vrfName" : "vrfName",
"connectMode" : "Nfvi",
"externalCidr" : ["192.168.1.0/24"],
"internalCidr" : ["192.168.2.0/24"],
"maxLoadBalance" : 10,
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.2 Query the Logical Router List
Typical Scenarios
All logical routers need to be queried.
Functions
Query all logical routers.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
type No string 0 to 36 - Type of a "transit"

charac logical router.
ters. The value is of
the
enumerated
type and can
be Normal,
Nfvi,
MultiActive,
Transit, or
Connect.

d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

ters. router is 65309"
located.

iMaster NCE-Fabric


ds 19-4FE6-
A5AD-3A9C9E2
65309"
name No string 0 to - Name of a "RouterName"

255 logical router.
charac
ters.
transit No string - - Logical router "false"

Conne information
ct used for
communication
that needs to
be queried (in
MDC
scenarios).

dex 255 number.
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers?producer=default&type=transit&tenantId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&logicNetworkId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&fabricIds=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&name=RouterName&transitConnect=false&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-983 LogicRoutersPagedDtoWrapper parameters

eter t Value
router ARRAY For details, see Table Logical router -

ENCE

um ] of queried
routers.

dex ] number.

ze ]
Table 1-984 QueryLogicRouterDto parameters

eter t Value
id string 36 characters. - Logical router "DBB702C3-77

The value must ID. This field 19-4FE6-
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 1 to 255 - Logical router "logicRouterNa

characters. name. me"

tion characters.

A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value

router is 65309"
located.
routerL ARRAY For details, see Table Router location -

ocatio _REFER 1-985. information.
set to Transit
or Connect,
this field
cannot be set.
Otherwise, this
field is
mandatory.
This field is
optional during
the update.
type string 0 to 255 - Logical router "Normal"

characters. type. The value
can be Normal,
Nfvi,
MultiActive,
Transit, or
Connect. This
field cannot be
updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.
vni int32 [1-16000000] - Online/offline 10

status of a
device. The
value cannot
be changed.

iMaster NCE-Fabric

eter t Value
vrfNa string 1 to 31 - VRF name. This "vrfName"

me characters. field cannot be
updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.
connec string 0 to 255 - Interconnection "Nfvi"

tMode characters. mode. The
value is of the
enumerated
type and can
be south-north,
east-west, all-
static, or
external-
gateway-group.
extern array< - - Address ["192.168.1.0/2

the connected
VPC through
the transit
router.
interna array< - - This parameter ["192.168.2.0/2

when the
transit router
needs to
connect to an
external
gateway or
another transit
router. It
defines the
access egress
of the transit
router.

iMaster NCE-Fabric

eter t Value
maxLo int32 [1-128] - Number of 10

adBala load-balancing
nce routes. The
priority of this
field is higher
than that of
the global
configuration.


65309"

Name characters.
egress string 0 to 255 - Egress "DBB702C3-77

Gatew characters. gateway. The 19-4FE6-
ayDev value consists A5AD-3A9C9E2
GrpId of the IDs of 65309"
the selected
devices or
device groups.
import array< 0-255 items. - Import route -

RouteT string> target
argets extended
community
attribute of
BGP EVPN on a
logical router.
export array< 0-255 items. - Export route -

argets extended
community
attribute of
BGP EVPN on a
logical router.
routes ARRAY For details, see Table Static route. -

_REFER 1-988.
ENCE

iMaster NCE-Fabric

eter t Value

s _REFER 1-989. information.
ENCE
bgp REFER For details, see Table BGP -

routerL REFER For details, see Table Location -

ocatio ENCE 1-985. information.
n
Table 1-985 RouterLocationDto parameters

eter t Value

65309"
fabricR string - - Fabric role. The "master"

ole value can be
master or
backup. This
parameter
cannot be
updated.

cannot be
updated.

Group _REFER 1-986. Devices in the
ENCE list must
belong to the
same device
group. If the
logical router
type is Normal,
the value of
this parameter
must be null.

iMaster NCE-Fabric

eter t Value

d characters. Either the 19-4FE6-
device group A5AD-3A9C9E2
ID or the 65309"
device
management
IP address
must be
specified. If a
device group is
selected, enter
only one device
ID. Only the
egress gateway
is displayed for
the query.

IP address.
Either the
device group
ID or the
device
management
IP address
must be
specified. If a
device group is
selected, enter
only one device
ID. Only the
egress gateway
is displayed for
the query.

iMaster NCE-Fabric

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.


Table 1-988 StaticRouteDto parameters

eter t Value
id string - - Static route ID. "DBB702C3-77

The value 19-4FE6-
changed. 65309"
routeS string 0 to 256 - Route set ID. "DBB702C3-77

etId characters. The value 19-4FE6-
changed. 65309"
addres string 1 to 255 - Address type. "Ipv4"

sFamil characters. The value can
yType be IPv4 or IPv6.
destina string 1 to 255 - Prefix of a "10.10.10.0/24"

tion characters. static route, in
CIDR format.

iMaster NCE-Fabric

eter t Value
nextho string 0 to 255 - Next-hop IP "10.1.1.1"

pIp characters. address of a
static route.
nextho string 0 to 255 - Next-hop VRF "vrf1"

pVrf characters. name of the
static route.
This parameter
is used when a
static route
crosses VRFs.
Either this
parameter or
nexthopLogicR
outerId must
be specified.
This parameter
is valid only
when source is
set to
SystemVas. The
value cannot
be changed.
nextho string 0 to 36 - Next-hop "DBB702C3-77

pLogic characters. router ID of 19-4FE6-
Router the static A5AD-3A9C9E2
Id route. This 65309"
parameter is
used when a
static route
crosses VRFs.
Either this
parameter or
nexthopVrf
must be
specified. This
parameter is
valid only
when source is
set to
SystemVas. The
value cannot
be changed.
prefere int32 [1-255] - Static route 10

nce priority. The
value can be
changed.

iMaster NCE-Fabric

eter t Value
nextho string 1 to 255 Ip Next hop type. "Ip"

pType characters. The value is of
the
enumerated
type and can
be Ip, EndPort,
or Indirect. The
value cannot
be changed.
trackTy string 0 to 255 - For normal "NQA"

pe characters. routes, this
parameter can
be set to None
or NQA; for
end port
routes, this
parameter can
be set to None,
AutoTrack
(automatic
one-armed),
ManualShared
Bfd (shared),
DoubleAutoTra
ck (automatic
two-armed), or
ManualSession
Bfd (specified
BFD session),
or left blank.
The value
cannot be
changed.
trackId string 0 to 255 - Track ID. The "DBB702C3-77

characters. value cannot 19-4FE6-
be changed A5AD-3A9C9E2
when 65309"
trackType is set
to NQA.
endPor string 0 to 36 - Port ID. The "DBB702C3-77

tId characters. value cannot 19-4FE6-
be changed. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
endPor string 0 to 255 - Port IP address. "10.1.1.1"

tIp characters. The value
cannot be
changed.
endPor string 0 to 255 - Association "endPortTrack

tTrack characters. name. The Name"
Name value cannot
be changed.
trackC boolea - false Association false

heck n detection
function. The
value cannot
be changed.

GroupI characters. ID. Either this 19-4FE6-
d parameter or A5AD-3A9C9E2
the device 65309"
group name
must be
specified. The
value cannot
be changed.

Group characters. name. Either ame"
Name this parameter
or the device
group ID must
be specified.
The value
cannot be
changed.
ecmp boolea - false Whether ECMP false

n is enabled.

iMaster NCE-Fabric

eter t Value
routeD string 0 to 36 - Position where "DeviceGroup"

epolyP characters. the static route
os is deployed.
The value is of
the
enumerated
type and can
be
DeviceGroup or
EndPort. The
value cannot
be changed.
loopba string 0 to 36 - Loopback "DBB702C3-77

ckId characters. interface ID, 19-4FE6-
which cannot A5AD-3A9C9E2
be updated. 65309"
deviceI array< - - Device ID. -

ds string>
Table 1-989 RouterSubnetDto parameters

eter t Value
id string 0 to 256 - Subnet ID. "DBB702C3-77

A5AD-3A9C9E2
65309"

characters. segment. The "
value can be
changed.

address. The
value can be
changed.

iMaster NCE-Fabric
Table 1-990 BgpDto parameters

eter t Value
addres string - - Address type. "vpnv4-

sFamil The value is of instance"
yType the
enumerated
type and can
be Vpnv4 or
Vpnv6. The
value cannot
be changed.
import boolea - false Whether direct false

Route n routes are
Direct imported. This
parameter
takes effect
only in
centralized
gateway
scenarios. The
value can be
changed.
import boolea - false Whether static false

RouteS n routes are
tatic imported. This
parameter
takes effect
only in
centralized
gateway
scenarios. The
value can be
changed.
import array< 0-255 items. - Import -

Netwo string> network. This
rks parameter
takes effect
only in
centralized
gateway
scenarios. The
value can be
changed.

iMaster NCE-Fabric

eter t Value
aggreg array< 0-255 items. - Aggregate -

ateRou string> route. This
tes parameter
takes effect
only in
centralized
gateway
scenarios. The
value can be
changed.
bgpPe ARRAY For details, see Table BGP -

er _REFER 1-991. configuration
ENCE on a logical
router.
Table 1-991 BgpPeerDto parameters

eter t Value
id string 0 to 256 - BGP peer ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
bgpRo string 0 to 256 - BGP route ID. "DBB702C3-77

uteId characters. The value 19-4FE6-
changed. 65309"
addres string 1 to 255 - Address type. "Vpnv4"

sFamil characters. The value is of
yType the
enumerated
type and can
be Vpnv4 or
Vpnv6.
descrip string 0 to 255 - Description "description"

tion characters.
peerIp string 1 to 255 - Peer IP "192.168.1.1"


iMaster NCE-Fabric

eter t Value
peerAs string 1 to 11 - Peer AS "10"

characters. number. The
value is in the
range from 1
to 4294967295
or is in the
format m.n, in
which m is in
the range from
1 to 65535,
and n is in the
range from 0
to 65535.
bgpPe string - Direct Peer type. The "Direct"

erType value is of the
enumerated
type and can
be Direct or
Indirect. The
value cannot
be changed.

GroupI characters. ID. Either 19-4FE6-
d device group A5AD-3A9C9E2
ID or name 65309"
must be
specified. This
parameter is
mandatory
when the
selected logical
router is bound
to a distributed
fabric.

iMaster NCE-Fabric

eter t Value

Group characters. name. Either ame"
Name device group
ID or name
must be
specified. This
parameter is
mandatory
when the
selected logical
router is bound
to a distributed
fabric.
sourceI ARRAY For details, see Table This parameter -

ps _REFER 1-992. is mandatory
ENCE when the
selected logical
router is of the
Nfvi type and
the peer device
is of the
Indirect type.
logicIn string 0 to 256 - ID of the "DBB702C3-77

terface characters. associated 19-4FE6-
Id interconnection A5AD-3A9C9E2
interface. 65309"
keepali int32 [0-21845] - Keepalive time. 1

veTime The value is an
integer that
ranges from 0
to 21845, in
seconds.

iMaster NCE-Fabric

eter t Value
holdTi int32 [0-65535] - Hold time. The 3

me value is an
integer that
can be 0 or
ranges from 3
to 65535, in
seconds.
Setting the
hold time to be
longer than
20s is
recommended.
If the hold time
is shorter than
20s, the BGP
peer session
may be
interrupted.
bfd boolea - false Whether false

n association
with BFD is
enabled. This
parameter can
be set only
when the peer
device is of the
Direct type.
allowA boolea - false Permit AS false

sLoop n loops.
default boolea - false Whether to false

Route n advertise the
Adverti default route.
se
import string 0 to 200 - Whether to "routePolicy"

RouteP characters. import the
olicy routing policy.
export string 0 to 200 - Whether to "routePolicy"

RouteP characters. export the
olicy routing policy.

iMaster NCE-Fabric

eter t Value
loopba string 0 to 200 - Loopback "DBB702C3-77

ckId characters. interface ID. 19-4FE6-
This parameter A5AD-3A9C9E2
takes effect for 65309"
indirect BGP
routes.
loopba string 0 to 255 - Loopback "loopbackNam

ckNam characters. interface name. e"
e This parameter
takes effect for
indirect BGP
routes.
sourceI string 0 to 256 - Source "DBB702C3-77

fId characters. interface ID. 19-4FE6-
A5AD-3A9C9E2
65309"
sourceI int32 [0-2] - Source 0

fType interface type,
which is
mandatory and
cannot be
changed. The
value is an
integer. The
value can be 0
(logical
switch), 1
(loopback
interface), or 2
(interconnectio
n interface).
ebgpM boolea - - Whether multi- false

ultiHo n hop EBGP is
p configured.
minTxI int32 [50-1000] - Interval at 1000

nterval which BFD
packets are
sent. The value
is in the range
from 50 to
1000, in
milliseconds.

iMaster NCE-Fabric

eter t Value
minRxI int32 [50-1000] - Interval at 1000

nterval which BFD
packets are
received. The
value is in the
range from 50
to 1000, in
milliseconds.
detect int32 [3-50] - Local detection 3

Multipl time multiplier.
ier The value is an
integer in the
range from 3
to 50.
fakeAs string 1 to 11 - Pseudo AS "10"

Num characters. number. The
value is in the
range from 1
to 4294967295
or is in the
format m.n, in
which m is in
the range from
1 to 65535,
and n is in the
range from 0
to 65535.
dualAs boolea - false The value true false

n indicates that
the EBGP peer
can use both
the real AS
number or a
pseudo AS
number to
establish a
connection
with the local
end.
auth REFER For details, see Table Authentication -


iMaster NCE-Fabric
Table 1-992 SourceIpConfigDto parameters

eter t Value

A5AD-3A9C9E2
65309"
loopba string 0 to 255 - IP address of a "192.168.3.3"

ckIp characters. loopback
interface.
Table 1-993 LogicRouterAuthDto parameters

eter t Value
authTy string 1 to 255 None Authentication "None"

pe characters. type. The value
is of the
enumerated
type and can
be Keychain,
Password, or
None.
keycha string 1 to 47 - Keychain "keychainNam

inNam characters. name. e"
e
passw string - Cipher Password "CipherText"

ordTyp Text character string
e type. The value
is of the
enumerated
type and can
be CipherText
or
EncryptedText.
passw string 1 to 255 - This field may "passwordText"

ordTex characters. contain
t sensitive or
personal data.
Keep it secure.
Password
character
string.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"router" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265311",
{
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"
}
]
}
],
"type" : "Normal",
"vni" : 10,
"externalCidr" : ["192.168.1.0/24"],
"internalCidr" : ["192.168.2.0/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"egressGatewayDevGrpId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"importRouteTargets" : [
"0:5006"
],
"exportRouteTargets" : [
"0:5006"
],
"routes" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"routeSetId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"addressFamilyType" : "Ipv4",
"destination" : "10.10.10.0/24",
"nexthopIp" : "10.1.1.1",
"nexthopVrf" : "vrf1",
"nexthopLogicRouterId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"preference" : 10,
"nexthopType" : "Ip",

iMaster NCE-Fabric
"trackType" : "NQA",
"trackId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"endPortId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"endPortIp" : "10.1.1.1",
"endPortTrackName" : "endPortTrackName",
"trackCheck" : false,
"ecmp" : false,
"routeDepolyPos" : "DeviceGroup",
"loopbackId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
],
"subnets" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gatewayIp" : "192.168.1.1"
}
],
"bgp" : {
"addressFamilyType" : "vpnv4-instance",
"importRouteDirect" : false,
"importRouteStatic" : false,
"importNetworks" : [
"192.168.1.0/24"
],
"aggregateRoutes" : [
"192.168.1.0/24"
],
"bgpPeer" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"bgpRouteId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"addressFamilyType" : "Vpnv4",
"peerIp" : "192.168.1.1",
"peerAs" : "10",
"bgpPeerType" : "Direct",
"sourceIps" : [
{
"loopbackIp" : "192.168.3.3"
}
],
"logicInterfaceId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"keepaliveTime" : 1,
"holdTime" : 3,
"bfd" : false,
"allowAsLoop" : false,
"defaultRouteAdvertise" : false,
"importRoutePolicy" : "routePolicy",
"exportRoutePolicy" : "routePolicy",
"loopbackName" : "loopbackName",
"sourceIfId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"sourceIfType" : 0,
"ebgpMultiHop" : false,
"minTxInterval" : 1000,
"minRxInterval" : 1000,
"detectMultiplier" : 3,
"fakeAsNum" : "10",
"dualAs" : false,
"auth" : {

iMaster NCE-Fabric
"authType" : "None",
"keychainName" : "keychainName",
"passwordType" : "CipherText",
"passwordText" : "passwordText"
}
}
]
},
"routerLocation" : {
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"
}
]
}
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.3 Query the Logical Router List
Typical Scenarios
Basic information about all logical routers needs to be queried.
Functions
Query all logical routers.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/basicinfo

iMaster NCE-Fabric


outerId 6044 ID. 19-4FE6-
s charac A5AD-3A9C9E2
ters. 65309;DBB702
C3-7719-4FE6-
A5AD-3A9C9E2
65311"

dex 255 number.
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/basicinfo?logicRouterIds=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309;DBB702C3-7719-4FE6-A5AD-3A9C9E265311&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-995 AcLogicRouterDtoListWrapper parameters

eter t Value

ENCE

iMaster NCE-Fabric

eter t Value

um ] of queried
routers.

dex ] number.

ze ]
Table 1-996 TenantLogicRoutersDto parameters

eter t Value
router REFER For details, see Table Logical router -

tenantI string 0 to 256 - Tenant ID. -

d characters.
tenant string 0 to 255 - Tenant name. -

Name characters.
Table 1-997 LogicRoutersDto parameters

eter t Value

regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.


tion characters.

iMaster NCE-Fabric

eter t Value

A5AD-3A9C9E2
65309"

router is 65309"
located.

set to Transit
or Connect,
this field
cannot be set.
Otherwise, this
field is
mandatory.
This field is
optional during
the update.

can be Normal,
Nfvi,
MultiActive,
Transit, or
Connect. This
field cannot be
updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.

status of a
device. The
value cannot
be changed.

iMaster NCE-Fabric

eter t Value

updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.

value is of the
enumerated
type and can
be south-north,
east-west, all-
static, or
external-
gateway-group.

the connected
VPC through
the transit
router.

when the
transit router
needs to
connect to an
external
gateway or
another transit
router. It
defines the
access egress
of the transit
router.

iMaster NCE-Fabric

eter t Value

nce routes. The
priority of this
field is higher
than that of
the global
configuration.

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"router" : [
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265311",
{
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"
}
]
}
],
"type" : "Normal",
"vni" : 10,
"externalCidr" : ["192.168.1.0/24"],
"internalCidr" : ["192.168.2.0/24"],
"additional" : {

iMaster NCE-Fabric
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.4 Query Information About All Logical Routers
Typical Scenarios
All logical routers need to be queried.
Functions
Query all logical routers based on specified conditions.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/access-router

name No string - - Name of a "logicRouterNa

logical router. me"
Fuzzy match is
supported.

iMaster NCE-Fabric


ds 19-4FE6-
A5AD-3A9C9E2
65309;DBB702
C3-7719-4FE6-
A5AD-3A9C9E2
65310"

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/access-router?
name=logicRouterName&fabricIds=DBB702C3-7719-4FE6-A5AD-3A9C9E265309;DBB702C3-7719-4FE6-
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-999 AccessRouterInfoDtoWrapper parameters

eter t Value

um ] of queried
routers.

iMaster NCE-Fabric

eter t Value
pageIn string 1 to - Page index. "1"

dex 2147483647
characters.
pageSi string 1 to - Page size. "1"

ze 2147483647
characters.
access ARRAY For details, see Table Logical router -

Router _REFER 1-1000. information.
ENCE
Table 1-1000 AccessRouterDto parameters

eter t Value

regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.


tion characters.

A5AD-3A9C9E2
65309"

router is 65309"
located.

iMaster NCE-Fabric

eter t Value

set to Transit
or Connect,
this field
cannot be set.
Otherwise, this
field is
mandatory.
This field is
optional during
the update.

can be Normal,
Nfvi,
MultiActive,
Transit, or
Connect. This
field cannot be
updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.

status of a
device. The
value cannot
be changed.

updated. If a
new value is
entered during
the update, the
value used
during the
creation is
retained and is
not updated.

iMaster NCE-Fabric

eter t Value

value is of the
enumerated
type and can
be south-north,
east-west, all-
static, or
external-
gateway-group.

the connected
VPC through
the transit
router.

when the
transit router
needs to
connect to an
external
gateway or
another transit
router. It
defines the
access egress
of the transit
router.

nce routes. The
priority of this
field is higher
than that of
the global
configuration.


65309"

iMaster NCE-Fabric

eter t Value

Name characters.
egress string 0 to 255 - Egress "DBB702C3-77

Gatew characters. gateway. The 19-4FE6-
ayDev value consists A5AD-3A9C9E2
GrpId of the IDs of 65309"
the selected
devices or
device groups.
import array< 0-255 items. - Import route -

argets extended
community
attribute of
BGP EVPN on a
logical router.
export array< 0-255 items. - Export route -

argets extended
community
attribute of
BGP EVPN on a
logical router.

_REFER 1-988.
ENCE

s _REFER 1-989. information.
ENCE
bgp REFER For details, see Table BGP -

routerL REFER For details, see Table Location -

ocatio ENCE 1-985. information.
n
fabricI array< 0-255 items. - List of fabric ["DBB702C3-7

ds string> IDs after 719-4FE6-
filtering. A5AD-3A9C9E2
65309"]

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"totalNum" : 200,
"pageIndex" : "1",
"pageSize" : "1",
"accessRouter" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265311",
{
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"
}
]
}
],
"type" : "Normal",
"vni" : 10,
"externalCidr" : ["192.168.1.0/24"],
"internalCidr" : ["192.168.2.0/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"0:5006"
],
"0:5006"
],
"routes" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"destination" : "10.10.10.0/24",
"nexthopIp" : "10.1.1.1",
"preference" : 10,

iMaster NCE-Fabric
"endPortIp" : "10.1.1.1",
"ecmp" : false,
"deviceIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
],
"subnets" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gatewayIp" : "192.168.1.1"
}
],
"bgp" : {
"192.168.1.0/24"
],
"192.168.1.0/24"
],
"bgpPeer" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peerIp" : "192.168.1.1",
"peerAs" : "10",
"sourceIps" : [
{
"loopbackIp" : "192.168.3.3"
}
],
"holdTime" : 3,
"bfd" : false,
"sourceIfType" : 0,
"fakeAsNum" : "10",
"dualAs" : false,
"auth" : {

iMaster NCE-Fabric
}
}
]
},
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"
}
]
},
"fabricIds" : ["DBB702C3-7719-4FE6-A5AD-3A9C9E265309"]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.5 Query Information About a Logical Router
Typical Scenarios
A logical router needs to be queried.
Functions
Query a logical router by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/{id}

iMaster NCE-Fabric


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1002 LogicRoutersDtoWrapper parameters

eter t Value

ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"router" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265311",
{
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"
}
]
}
],
"type" : "Normal",
"vni" : 10,
"externalCidr" : ["192.168.1.0/24"],
"internalCidr" : ["192.168.2.0/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"0:5006"
],
"0:5006"
],
"routes" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"destination" : "10.10.10.0/24",
"nexthopIp" : "10.1.1.1",
"preference" : 10,
"endPortIp" : "10.1.1.1",
"ecmp" : false,
"deviceIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
],

iMaster NCE-Fabric
"subnets" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"cidr" : "192.168.1.0/24",
"gatewayIp" : "192.168.1.1"
}
],
"bgp" : {
"192.168.1.0/24"
],
"192.168.1.0/24"
],
"bgpPeer" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peerIp" : "192.168.1.1",
"peerAs" : "10",
"sourceIps" : [
{
"loopbackIp" : "192.168.3.3"
}
],
"holdTime" : 3,
"bfd" : false,
"sourceIfType" : 0,
"fakeAsNum" : "10",
"dualAs" : false,
"auth" : {
}
}
]
},
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"

iMaster NCE-Fabric
}
]
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.6 Update a Logical Router
Typical Scenarios
A logical router needs to be updated.
Functions
Update a logical router by ID.
Constraints
HTTP Method
PUT
URI

id Yes string 0 to - ID used for "DBB702C3-77

256 query. The 19-4FE6-
charac value cannot A5AD-3A9C9E2
ters. be changed. 65309"

iMaster NCE-Fabric
Request Parameters


updating a
logical router.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265311",
{
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"
}
]
}
],
"type" : "Normal",
"vni" : 10,
"externalCidr" : ["192.168.1.0/24"],
"internalCidr" : ["192.168.2.0/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Response Parameters

iMaster NCE-Fabric

eter t Value
router REFER For details, see Table Logical router -

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"router" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265311",
{
"deviceGroup" : [
{
"deviceIp" : "192.168.1.1"
}
]
}
],
"type" : "Normal",
"vni" : 10,
"externalCidr" : ["192.168.1.0/24"],
"internalCidr" : ["192.168.2.0/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.6.7 Delete a Logical Router
Typical Scenarios
A logical router needs to be deleted.
Functions
Delete a logical router by ID.
Constraints
HTTP Method
DELETE
URI


ters. 65309"

iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309?
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.8 Add Static Route Information to a Logical Router
Typical Scenarios
Static route information needs to be added to a logical router.
Functions
Add one or more static routes to a logical router. If multiple routes need to be
added, add them in one transaction. If any route fails to be added, all routes will
be rolled back.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/routers/router/{id}/route-sets

id Yes string 0 to - ID of a logical "DBB702C3-77

256 router to which 19-4FE6-
charac static routes A5AD-3A9C9E2
ters. belong. 65309"

iMaster NCE-Fabric
Request Parameters

routes Yes REFER For details, see Static route -

ENCE Table 1-1010. configuration,
which is of the
input
parameter
model class.
Table 1-1010 LogicRouterRoutesDtoWrapper parameters

routeId No string 1 to - Static route "DBB702C3-77

128 group ID, 19-4FE6-
charac which cannot A5AD-3A9C9E2
ters. be the same as 65309"
an existing
logical router
ID.
logicR No string 0 to 36 - Logical router "DBB702C3-77

outerId charac ID. This 19-4FE6-
ters. parameter is A5AD-3A9C9E2
used only for 65309"
querying the
return value.

iMaster NCE-Fabric

source No string 0 to - Source. The "SystemVas"

255 value is of the
charac enumerated
ters. type and can
be Manual or
SystemVas. The
default value is
SystemVas. The
static route
groups of the
Manual type
are displayed
on the page
(recommended
), while the
static route
groups of the
SystemVas
type are not
displayed.
routes Yes ARRAY For details, see Static route. -

_REFER Table 1-1011.
ENCE

Table 1-1011 StaticRouteDto parameters

id No string - - Static route ID. "DBB702C3-77

The value 19-4FE6-
changed. 65309"
routeS No string 0 to - Route set ID. "DBB702C3-77

etId 256 The value 19-4FE6-
charac cannot be A5AD-3A9C9E2
ters. changed. 65309"
addres No string 1 to - Address type. "Ipv4"

sFamil 255 The value can
yType charac be IPv4 or IPv6.
ters.

iMaster NCE-Fabric

destina Yes string 1 to - Prefix of a "10.10.10.0/24"

tion 255 static route, in
charac CIDR format.
ters.
nextho No string 0 to - Next-hop IP "10.1.1.1"

pIp 255 address of a
charac static route.
ters.
nextho No string 0 to - Next-hop VRF "vrf1"

pVrf 255 name of the
charac static route.
ters. This parameter
is used when a
static route
crosses VRFs.
Either this
parameter or
nexthopLogicR
outerId must
be specified.
This parameter
is valid only
when source is
set to
SystemVas. The
value cannot
be changed.
nextho No string 0 to 36 - Next-hop "DBB702C3-77

pLogic charac router ID of 19-4FE6-
Router ters. the static A5AD-3A9C9E2
Id route. This 65309"
parameter is
used when a
static route
crosses VRFs.
Either this
parameter or
nexthopVrf
must be
specified. This
parameter is
valid only
when source is
set to
SystemVas. The
value cannot
be changed.

iMaster NCE-Fabric

prefere No int32 [1-255 - Static route 10

nce ] priority. The
value can be
changed.
nextho No string 1 to Ip Next hop type. "Ip"

pType 255 The value is of
charac the
ters. enumerated
type and can
be Ip, EndPort,
or Indirect. The
value cannot
be changed.
trackTy No string 0 to - For normal "NQA"

pe 255 routes, this
charac parameter can
ters. be set to None
or NQA; for
end port
routes, this
parameter can
be set to None,
AutoTrack
(automatic
one-armed),
ManualShared
Bfd (shared),
DoubleAutoTra
ck (automatic
two-armed), or
ManualSession
Bfd (specified
BFD session),
or left blank.
The value
cannot be
changed.
trackId No string 0 to - Track ID. The "DBB702C3-77

255 value cannot 19-4FE6-
charac be changed A5AD-3A9C9E2
ters. when 65309"
trackType is set
to NQA.

iMaster NCE-Fabric

endPor No string 0 to 36 - Port ID. The "DBB702C3-77

tId charac value cannot 19-4FE6-
ters. be changed. A5AD-3A9C9E2
65309"
endPor No string 0 to - Port IP address. "10.1.1.1"

tIp 255 The value
charac cannot be
ters. changed.
endPor No string 0 to - Association "endPortTrack

tTrack 255 name. The Name"
Name charac value cannot
ters. be changed.
trackC No boolea - false Association false

heck n detection
function. The
value cannot
be changed.
device No string 0 to 36 - Device group "DBB702C3-77

GroupI charac ID. Either this 19-4FE6-
d ters. parameter or A5AD-3A9C9E2
the device 65309"
group name
must be
specified. The
value cannot
be changed.

Group 255 name. Either ame"
Name charac this parameter
ters. or the device
group ID must
be specified.
The value
cannot be
changed.
ecmp No boolea - false Whether ECMP false

n is enabled.

iMaster NCE-Fabric

routeD No string 0 to 36 - Position where "DeviceGroup"

epolyP charac the static route
os ters. is deployed.
The value is of
the
enumerated
type and can
be
DeviceGroup or
EndPort. The
value cannot
be changed.
loopba No string 0 to 36 - Loopback "DBB702C3-77

ckId charac interface ID, 19-4FE6-
ters. which cannot A5AD-3A9C9E2
be updated. 65309"
deviceI No array< - - Device ID. -

ds string>
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/route-sets
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routeId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"source" : "SystemVas",
"routes" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"destination" : "10.10.10.0/24",
"nexthopIp" : "10.1.1.1",
"preference" : 10,
"endPortIp" : "10.1.1.1",

iMaster NCE-Fabric
"ecmp" : false,
"deviceIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.9 Update Static Routes on a Logical Router
Typical Scenarios
Static route information needs to be added to a logical router.
Functions
Update one or more static routes on a logical router. If multiple routes need to be
updated, update them in one transaction. If any route fails to be updated, all
routes will be rolled back.
Constraints

iMaster NCE-Fabric
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/routers/router/{id}/route-sets

id Yes string 0 to - ID of a logical "DBB702C3-77

256 router to which 19-4FE6-
charac static routes A5AD-3A9C9E2
ters. belong. 65309"
Request Parameters

routes Yes REFER For details, see Static route -

ENCE Table 1-1010. configuration,
which is of the
input
parameter
model class.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/route-sets
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routes" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"destination" : "10.10.10.0/24",
"nexthopIp" : "10.1.1.1",
"preference" : 10,
"endPortIp" : "10.1.1.1",
"ecmp" : false,
"deviceIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.6.10 Query Static Route Information on a Logical Router
Typical Scenarios
Static route information on a logical router needs to be queried.
Functions
Query static route information on a logical router.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/route-sets/route-set/{id}

id Yes string 1 to - Route set ID. "DBB702C3-77

128 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/route-sets/route-set/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1015 LogicRouterRoutesDtoWrapper parameters

eter t Value
routeId string 1 to 128 - Static route "DBB702C3-77

characters. group ID, 19-4FE6-
be the same as 65309"
an existing
logical router
ID.

outerId characters. ID. This 19-4FE6-
parameter is A5AD-3A9C9E2
querying the
return value.
source string 0 to 255 - Source. The "SystemVas"

characters. value is of the
enumerated
type and can
be Manual or
SystemVas. The
default value is
SystemVas. The
static route
groups of the
Manual type
are displayed
on the page
(recommended
), while the
static route
groups of the
SystemVas
type are not
displayed.

_REFER 1-988.
ENCE


iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routes" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"destination" : "10.10.10.0/24",
"nexthopIp" : "10.1.1.1",
"preference" : 10,
"endPortIp" : "10.1.1.1",
"ecmp" : false,
"deviceIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.11 Delete Static Route Information from a Logical Router
Typical Scenarios
Static route information needs to be deleted from a logical router.

iMaster NCE-Fabric
Functions
Delete one or more static routes from a logical router. If multiple routes need to
be deleted, delete them in one transaction. If any route fails to be deleted, all
routes will be rolled back.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/logicnetwork/routers/router/route-sets/route-set/{id}

id Yes string 1 to - Route set ID. "DBB702C3-77

128 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/routers/router/route-sets/route-set/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309?producer=default HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.12 Query Static Routes in Batches Based on Specified Conditions
Typical Scenarios
Static routes need to be queried in batches based on specified conditions.
Functions
Query static routes in batches based on specified conditions.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/route-sets


outerId charac ID. 19-4FE6-
ters. A5AD-3A9C9E2
65309"

specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
destina No array< - - Destination -

tions string> address, in
array format.
sourceI No array< - - Source address, -

ps string> in array
format.
nextho No int32 - - Type of the 0

pType next hop. This
parameter is
optional. The
value can be 0
(IP address), 1
(port ID), or 2
(instance
name).

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/route-sets?logicRouterId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&producer=default&nexthopType=0 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1019 LogicRouterRoutesListWrapper parameters

eter t Value
routes ARRAY For details, see Table Logical router -

ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routes" : [
{
"routes" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"destination" : "10.10.10.0/24",
"nexthopIp" : "10.1.1.1",
"preference" : 10,
"endPortIp" : "10.1.1.1",
"ecmp" : false,
"deviceIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.13 Add BGP Peers to a Logical Router
Typical Scenarios
One or more BGP peers need to be added to a logical router.
Functions
Add one or more BGP peers to a logical router. If multiple BGP peers need to be
added, add them in one transaction. If any BGP peer fails to be added, all BGP
peers will be rolled back.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/controller/dc/v3/logicnetwork/routers/router/{id}/bgp-peers

id Yes string 0 to - ID of the "DBB702C3-77

256 logical router 19-4FE6-
charac to which the A5AD-3A9C9E2
ters. BGP peer 65309"
belongs.
Request Parameters

bgpPe Yes REFER For details, see BGP peer -

ers ENCE Table 1-1022. configuration,
which is of the
input
parameter
model class.
Table 1-1022 LogicRouterBgpPeerDtoWrapper parameters

routeId No string 1 to - BGP group ID, "FFF702C3-771

128 which cannot 9-4FE6-
charac be the same as A5AD-3A9C9E2
ters. an existing 65309"
logical router
ID.

querying the
return value.

iMaster NCE-Fabric

bgpPe Yes ARRAY For details, see BGP peer -

ers _REFER Table 1-1023. information.
ENCE

Table 1-1023 BgpPeerDto parameters

id Yes string 0 to - BGP peer ID. "DBB702C3-77

256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
bgpRo No string 0 to - BGP route ID. "DBB702C3-77

uteId 256 The value 19-4FE6-
ters. changed. 65309"
addres Yes string 1 to - Address type. "Vpnv4"

sFamil 255 The value is of
yType charac the
ters. enumerated
type and can
be Vpnv4 or
Vpnv6.
descrip No string 0 to - Description "description"

tion 255
charac
ters.
peerIp Yes string 1 to - Peer IP "192.168.1.1"

255 address.
charac
ters.

iMaster NCE-Fabric

peerAs Yes string 1 to 11 - Peer AS "10"

charac number. The
ters. value is in the
range from 1
to 4294967295
or is in the
format m.n, in
which m is in
the range from
1 to 65535,
and n is in the
range from 0
to 65535.
bgpPe No string - Direct Peer type. The "Direct"

erType value is of the
enumerated
type and can
be Direct or
Indirect. The
value cannot
be changed.

GroupI 256 ID. Either 19-4FE6-
d charac device group A5AD-3A9C9E2
ters. ID or name 65309"
must be
specified. This
parameter is
mandatory
when the
selected logical
router is bound
to a distributed
fabric.

iMaster NCE-Fabric


Group 255 name. Either ame"
Name charac device group
ters. ID or name
must be
specified. This
parameter is
mandatory
when the
selected logical
router is bound
to a distributed
fabric.
sourceI No ARRAY For details, see This parameter -

ps _REFER Table 1-1024. is mandatory
ENCE when the
selected logical
router is of the
Nfvi type and
the peer device
is of the
Indirect type.
logicIn No string 0 to - ID of the "DBB702C3-77

terface 256 associated 19-4FE6-
Id charac interconnection A5AD-3A9C9E2
ters. interface. 65309"
keepali No int32 [0-218 - Keepalive time. 1

veTime 45] The value is an
integer that
ranges from 0
to 21845, in
seconds.

iMaster NCE-Fabric

holdTi No int32 [0-655 - Hold time. The 3

me 35] value is an
integer that
can be 0 or
ranges from 3
to 65535, in
seconds.
Setting the
hold time to be
longer than
20s is
recommended.
If the hold time
is shorter than
20s, the BGP
peer session
may be
interrupted.
bfd No boolea - false Whether false

n association
with BFD is
enabled. This
parameter can
be set only
when the peer
device is of the
Direct type.
allowA No boolea - false Permit AS false

sLoop n loops.
default No boolea - false Whether to false

Route n advertise the
Adverti default route.
se
import No string 0 to - Whether to "routePolicy"

RouteP 200 import the
olicy charac routing policy.
ters.
export No string 0 to - Whether to "routePolicy"

RouteP 200 export the
olicy charac routing policy.
ters.

iMaster NCE-Fabric

loopba No string 0 to - Loopback "DBB702C3-77

ckId 200 interface ID. 19-4FE6-
charac This parameter A5AD-3A9C9E2
ters. takes effect for 65309"
indirect BGP
routes.
loopba No string 0 to - Loopback "loopbackNam

ckNam 255 interface name. e"
e charac This parameter
ters. takes effect for
indirect BGP
routes.
sourceI No string 0 to - Source "DBB702C3-77

fId 256 interface ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
sourceI No int32 [0-2] - Source 0

fType interface type,
which is
mandatory and
cannot be
changed. The
value is an
integer. The
value can be 0
(logical
switch), 1
(loopback
interface), or 2
(interconnectio
n interface).
ebgpM No boolea - - Whether multi- false

ultiHo n hop EBGP is
p configured.
minTxI No int32 [50-10 - Interval at 1000

nterval 00] which BFD
packets are
sent. The value
is in the range
from 50 to
1000, in
milliseconds.

iMaster NCE-Fabric

minRxI No int32 [50-10 - Interval at 1000

nterval 00] which BFD
packets are
received. The
value is in the
range from 50
to 1000, in
milliseconds.
detect No int32 [3-50] - Local detection 3

Multipl time multiplier.
ier The value is an
integer in the
range from 3
to 50.
fakeAs No string 1 to 11 - Pseudo AS "10"

Num charac number. The
ters. value is in the
range from 1
to 4294967295
or is in the
format m.n, in
which m is in
the range from
1 to 65535,
and n is in the
range from 0
to 65535.
dualAs No boolea - false The value true false

n indicates that
the EBGP peer
can use both
the real AS
number or a
pseudo AS
number to
establish a
connection
with the local
end.
auth No REFER For details, see Authentication -


iMaster NCE-Fabric
Table 1-1024 SourceIpConfigDto parameters


d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
loopba No string 0 to - IP address of a "192.168.3.3"

ckIp 255 loopback
charac interface.
ters.
Table 1-1025 LogicRouterAuthDto parameters

authTy Yes string 1 to None Authentication "None"

pe 255 type. The value
charac is of the
ters. enumerated
type and can
be Keychain,
Password, or
None.
keycha No string 1 to 47 - Keychain "keychainNam

inNam charac name. e"
e ters.
passw No string - Cipher Password "CipherText"

ordTyp Text character string
e type. The value
is of the
enumerated
type and can
be CipherText
or
EncryptedText.
passw No string 1 to - This field may "passwordText"

ordTex 255 contain
t charac sensitive or
Keep it secure.
Password
character
string.

iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/bgp-peers
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routeId" : "FFF702C3-7719-4FE6-A5AD-3A9C9E265309",
"bgpPeers" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peerIp" : "192.168.1.1",
"peerAs" : "10",
"sourceIps" : [
{
"loopbackIp" : "192.168.3.3"
}
],
"holdTime" : 3,
"bfd" : false,
"sourceIfType" : 0,
"fakeAsNum" : "10",
"dualAs" : false,
"auth" : {
}
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.14 Update BGP Peers on a Logical Router
Typical Scenarios
One or more BGP peers on a logical router need to be updated.
Functions
Update one or more BGP peers on a logical router. If multiple BGP peers need to
be updated, update them in one transaction. If any BGP peer fails to be updated,
all BGP peers will be rolled back.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/routers/router/{id}/bgp-peers

iMaster NCE-Fabric

id Yes string 0 to - ID of the "DBB702C3-77

256 logical router 19-4FE6-
ters. BGP peer 65309"
belongs.
Request Parameters

bgpPe Yes REFER For details, see BGP peer -

ers ENCE Table 1-1022. configuration,
which is of the
input
parameter
model class.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/bgp-peers
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"bgpPeers" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peerIp" : "192.168.1.1",
"peerAs" : "10",
"sourceIps" : [
{
"loopbackIp" : "192.168.3.3"
}

iMaster NCE-Fabric
],
"holdTime" : 3,
"bfd" : false,
"sourceIfType" : 0,
"fakeAsNum" : "10",
"dualAs" : false,
"auth" : {
}
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.6.15 Query BGP Peer Information on a Logical Router
Typical Scenarios
BGP peer information on a logical router needs to be queried.
Functions
Query BGP peer information on a logical router.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/bgp-peers/bgp-peer/{bgpRouteId}

bgpRo Yes string 1 to - BGP route ID. "DBB702C3-77

uteId 128 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/bgp-peers/bgp-peer/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1029 LogicRouterBgpPeerDtoWrapper parameters

eter t Value
routeId string 1 to 128 - BGP group ID, "FFF702C3-771

characters. which cannot 9-4FE6-
be the same as A5AD-3A9C9E2
an existing 65309"
logical router
ID.

querying the
return value.
bgpPe ARRAY For details, see Table BGP peer -

ers _REFER 1-991. information.
ENCE

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"bgpPeers" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peerIp" : "192.168.1.1",
"peerAs" : "10",
"sourceIps" : [
{

iMaster NCE-Fabric
"loopbackIp" : "192.168.3.3"
}
],
"holdTime" : 3,
"bfd" : false,
"sourceIfType" : 0,
"fakeAsNum" : "10",
"dualAs" : false,
"auth" : {
}
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.16 Delete BGP Peers from a Logical Router
Typical Scenarios
One or more BGP peers need to be deleted from a logical router.
Functions
Delete one or more BGP peers from a logical router. If multiple BGP peers need to
be deleted, delete them in one transaction. If any BGP peer fails to be deleted, all
BGP peers will be rolled back.
Constraints

iMaster NCE-Fabric
HTTP Method
DELETE
URI
/controller/dc/v3/logicnetwork/routers/router/bgp-peers/bgp-peer/{bgpRouteId}

bgpRo Yes string 1 to - BGP route ID. "DBB702C3-77

uteId 128 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/routers/router/bgp-peers/bgp-peer/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309?producer=default HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.17 Query BGP Peer Information in Batches Based on Specified Conditions
Typical Scenarios
BGP peers need to be queried in batches based on specified conditions.
Functions
Query BGP peers in batches based on specified conditions.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/bgp-peers

iMaster NCE-Fabric


outerId charac ID. 19-4FE6-
ters. A5AD-3A9C9E2
65309"

specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/bgp-peers?logicRouterId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&producer=default HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1033 LogicRouterBgpPeerListWrapper parameters

eter t Value
bgpPe ARRAY For details, see Table BGP peer -

ers _REFER 1-1029. information.
ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"bgpPeers" : [
{
"bgpPeers" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"peerIp" : "192.168.1.1",
"peerAs" : "10",
"sourceIps" : [
{
"loopbackIp" : "192.168.3.3"
}
],
"holdTime" : 3,
"bfd" : false,
"sourceIfType" : 0,
"fakeAsNum" : "10",

iMaster NCE-Fabric
"dualAs" : false,
"auth" : {
}
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.18 Query Device Groups Bound to a Logical Router
Typical Scenarios
Device groups bound to a logical router need to be queried.
Functions
Query device groups bound to a logical router.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/{id}/devicegroup-bindinfo

iMaster NCE-Fabric

id Yes string 0 to - Logical router "DBB702C3-77

256 ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

bussin No string 0 to - Service type. "default"

essTyp 128
e charac
ters.
bussin No string 0 to - Service ID. "DBB702C3-77

essId 128 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/
devicegroup-bindinfo?bussinessType=default&bussinessId=DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1036 DeviceGroupBindWrapper parameters

eter t Value
device REFER For details, see Table Bound device -

group ENCE 1-1037. group
information.
Table 1-1037 DeviceGroupBindInfoDto parameters

eter t Value

querying the
return value.
bussin string 0 to 256 - Service ID, "DBB702C3-77

essId characters. which identifies 19-4FE6-
the service that A5AD-3A9C9E2
is being 65309"
operated.
bussin string 1 to 255 - Service type. "DciRoutePolic

essTyp characters. y"
e
device array< Each item has 0 - Device group -

groups string> to 256 ID.
characters.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"devicegroup" : {

iMaster NCE-Fabric
"bussinessId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"bussinessType" : "DciRoutePolicy",
"devicegroups" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.19 Query Device Groups Bound to a Logical Router in Batches
Typical Scenarios
Device groups bound to a logical router need to be queried in batches.
Functions
Query device groups bound to a logical router in batches.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/devicegroup-bindinfos


charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric

bussin No string 0 to - Service type. "Dci"

essTyp 128 The value can
e charac be Dci, ExtGw,
ters. RouterConnecti
on, LogicWaf,
Nfvi, Null0,
MplsVpn,
MdcDciGatewa
y, LoopBack, or
DciRoutePolicy.
bussin No string 0 to - Service ID. "DBB702C3-77

essId 128 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/devicegroup-bindinfos?
logicRouterId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&bussinessType=Dci&bussinessId=DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1039 DeviceGroupBindListWrapper parameters

eter t Value
device ARRAY For details, see Table Bound device -

group _REFER 1-1037. group
ENCE information.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"devicegroup" : [
{
"devicegroups" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.20 Query Routing Policies Bound to a Logical Router
Typical Scenarios
Bound routing policies on a logical router need to be queried.
Functions
Query routing policies bound to a logical router.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/bind-route-policy

iMaster NCE-Fabric

produc No string 0 to - Producer of the -

er 128 binding
charac relationship.
ters.
routeP No string 0 to - ID of a routing -

olicyId 128 policy.
charac
ters.
routerI No string 0 to - routerId -

d 128
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/bind-route-policy HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1041 BindRoutePolicyInfoDtoWrapper parameters

eter t Value
routeP ARRAY For details, see Table Bound routing -

olicyInf _REFER 1-1042. policy
oDto ENCE information.

iMaster NCE-Fabric
Table 1-1042 BindRoutePolicyDto parameters

eter t Value
routerI string 0 to 256 - Logical router "DBB702C3-77

d characters. ID. This field 19-4FE6-
updated. 65309"
routeP string - - ID of a routing "DBB702C3-77

olicyId policy. 19-4FE6-
A5AD-3A9C9E2
65309"
type string - - Binding mode. "ribonly,

import, export,
preference."
instanc string - - Address family "vpn,evpn,both

eType type. "
device array< Each item has 0 - Device group -

GroupI string> to 256 information.
ds characters.

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"routePolicyInfoDto" : [
{
"routerId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"routePolicyId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"type" : "ribonly, import, export, preference.",
"instanceType" : "vpn,evpn,both",
"deviceGroupIds" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"

iMaster NCE-Fabric
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.21 Bind Routing Policies to a Logical Router
Typical Scenarios
Routing policies need to be bound to a logical router.
Functions
Bind routing policies to a logical router.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/routers/router/bind-route-policy
Request Parameters

bingRo Yes REFER For details, see Bound routing -

utePoli ENCE Table 1-1044. policy
cyInfo information.

iMaster NCE-Fabric
Table 1-1044 BindRoutePolicyDtoWrapper parameters

bindRo No REFER For details, see Bound routing -

cyDto information.
Table 1-1045 BindRoutePolicyDto parameters

routerI No string 0 to - Logical router "DBB702C3-77

d 256 ID. This field 19-4FE6-
routeP No string - - ID of a routing "DBB702C3-77

olicyId policy. 19-4FE6-
A5AD-3A9C9E2
65309"
type No string - - Binding mode. "ribonly,

import, export,
preference."
instanc No string - - Address family "vpn,evpn,both

eType type. "
device No array< Each - Device group -

GroupI string> item information.
ds has 0
to 256
charac
ters.

Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/routers/router/bind-route-policy HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{

iMaster NCE-Fabric
"bindRoutePolicyDto" : {
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.22 Unbind Routing Policies from a Logical Router
Typical Scenarios
Routing policies need to be unbound from a logical router.
Functions
Unbind routing policies from a logical router.
Constraints

iMaster NCE-Fabric
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/routers/router/unbind-route-policy
Request Parameters

bingRo Yes REFER For details, see Bound routing -

cyInfo information.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/routers/router/unbind-route-policy HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"bindRoutePolicyDto" : {
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.23 Bind Device Groups to a Logical Router
Typical Scenarios
One or more device groups need to be bound to a logical router.
Functions
Bind one or more device groups to a logical router. If multiple device groups need
to be bound, bind them in one transaction. If one device group fails to be bound,
all device groups will be rolled back.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/routers/router/{id}/bind-devicegroups


256 ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

device Yes REFER For details, see Static route -

groups ENCE Table 1-1049. configuration,
which is of the
input
parameter
model class.
Table 1-1049 DeviceGroupBindWrapper parameters

device Yes REFER For details, see Bound device -

group ENCE Table 1-1050. group
information.
Table 1-1050 DeviceGroupBindInfoDto parameters


querying the
return value.
bussin No string 0 to - Service ID, "DBB702C3-77

essId 256 which identifies 19-4FE6-
charac the service that A5AD-3A9C9E2
ters. is being 65309"
operated.
bussin No string 1 to - Service type. "DciRoutePolic

essTyp 255 y"
e charac
ters.

iMaster NCE-Fabric

device No array< Each - Device group -

groups string> item ID.
has 0
to 256
charac
ters.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/bind-
devicegroups HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"devicegroup" : {
"devicegroups" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.6.24 Unbind Device Groups from a Logical Router
Typical Scenarios
One or more device groups need to be unbound from a logical router.
Functions
Unbind one or more device groups from a logical router. If multiple device groups
need to be unbound, unbind them in one transaction. If one device group fails to
be unbound, all device groups will be rolled back.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/routers/router/{id}/unbind-devicegroups


256 ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters


which is of the
input
parameter
model class.
Table 1-1053 DeviceGroupUnbindWrapper parameters

device Yes REFER For details, see Bound device -

group ENCE Table 1-1050. group
information.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/routers/router/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/unbind-
devicegroups HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"devicegroup" : {
"devicegroups" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
}
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.25 Query the Binding Relationship Between a Logical Router and an

External Gateway
Typical Scenarios
The binding relationship between a logical router and an external gateway needs
to be queried.
Functions
Query the binding relationship between a logical router and an external gateway.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/routers/router/bind-external-gateway

id No string 0 to - Logical router -

128 ID.
charac
ters.

iMaster NCE-Fabric

produc No string 0 to - Producer of the -

er 128 binding
charac relationship.
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/routers/router/bind-external-gateway HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1055 BindExternalGatewaysWrapper parameters

eter t Value
bindEx ARRAY For details, see Table List of bound -

ternal _REFER 1-1056. external
Gatew ENCE gateways.
ayInfo
Table 1-1056 BindExternalGatewayWrapper parameters

eter t Value
routerI string 0 to 256 - Logical router "DBB702C3-77

d characters. ID. This field 19-4FE6-
updated. 65309"
bindInf ARRAY For details, see Table Bound external -

o _REFER 1-1057. gateway
ENCE information.

iMaster NCE-Fabric

eter t Value

Table 1-1057 BindExternalGatewayDto parameters

eter t Value
dciGwI string 0 to 256 - Device group -

d characters. ID.
extern string 0 to 256 - External -

alGate characters. gateway ID.
wayId
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"bindExternalGatewayInfo" : [
{
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.6.26 Bind an External Gateway to a Logical Router
Typical Scenarios
An external gateway needs to be bound to a logical router.
Functions
Bind an external gateway to a logical router.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/routers/router/bind-external-gateway
Request Parameters


which is of the
input
parameter
model class.
Table 1-1059 BindExternalGatewayWrapper parameters

routerI No string 0 to - Logical router "DBB702C3-77

d 256 ID. This field 19-4FE6-

iMaster NCE-Fabric

bindInf Yes ARRAY For details, see Bound external -

o _REFER Table 1-1060. gateway
ENCE information.

Table 1-1060 BindExternalGatewayDto parameters

dciGwI No string 0 to - Device group -

d 256 ID.
charac
ters.
extern No string 0 to - External -

alGate 256 gateway ID.
wayId charac
ters.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/routers/router/bind-external-gateway HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.6.27 Switch Active and Standby Fabrics of a Logical Router
Typical Scenarios
Active and standby fabrics of a logical router need to be switched.
Functions
Switch active and standby fabrics of a logical router that has been bound. Only
the distributed fabric is supported.
Constraints
User roles: northbound operator and system administrator.
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/routers/switchfabricrole
Request Parameters

logicR Yes REFER For details, see List of logical -

outerId ENCE Table 1-1062. router IDs.
s

iMaster NCE-Fabric
Table 1-1062 LogicRouterIdsWrapper parameters

logicR Yes array< Each - Logical router -

outerId string> item ID.
s has 0
to 256
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/routers/switchfabricrole HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"logicRouterIds" : [
"2b1daff5-44f1-4209-b7ef-c0277b4b2a01"
]
}
Response Parameters
Table 1-1063 SwitchFabricRoleOutputWrapper parameters

eter t Value
logicR array< Each item has 0 - Logical router -

outerId string> to 256 ID.
s characters.
taskId string 0 to 256 - Task ID. "2b1daff5-44f1

characters. -4209-b7ef-
c0277b4b2a01"
Sample Response

iMaster NCE-Fabric
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"logicRouterIds" : [
"2b1daff5-44f1-4209-b7ef-c0277b4b2a01"
],
"taskId" : "2b1daff5-44f1-4209-b7ef-c0277b4b2a01"
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.7 Logical Interface Management

APIs for adding, deleting, and querying logical interfaces.
1.9.7.7.1 Create a Layer 3 Logical Interface
Typical Scenarios
A Layer 3 logical interface needs to be created.
Functions
Create a Layer 3 logical port.
Constraints
A created router interface can be unbound from a subnet on the GUI.
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/interfaces

iMaster NCE-Fabric
Request Parameters


logical
interface.
Table 1-1065 LogicInterfaceListDtoWrapper parameters

interfa Yes ARRAY For details, see Logical -

ce _REFER Table 1-1066. interface
ENCE information.
Table 1-1066 LogicInterfaceDto parameters


ters. 65309"
name No string 1 to - Object name. "logicInterface

255 This field can Name"
charac be updated.
ters.

charac
ters.

outerId 256 ID. This field 19-4FE6-
extern No string 0 to - ID of the "DBB702C3-77

alGate 256 external 19-4FE6-
wayId charac gateway. A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric

interfa Yes string 0 to - Port type. The "RouterInterfac

ceType 255 options are as e"
charac follows:
ters. RouterInterface
: broadcast
domain port.
ConnectInterfa
ce:
interconnection
port. This field
cannot be
updated.
mac No string 0 to - MAC address "00:00:5E:

255 of an interface 00:01:01"
charac in a broadcast
ters. domain. The
value can be
changed.
ip No REFER For details, see IP address of a -

ENCE Table 1-1067. logical
interface.
subIp No array< - - Secondary IP ["192.168.1.1/2

string> address of an 4"]
interface. For
an interface in
a broadcast
domain, a
matching
subnet must
exist under the
logical switch.
This parameter
cannot be set
for an
interconnection
interface. The
value is a
character
string. The
value can be
changed.

iMaster NCE-Fabric

logicS No string 0 to - RouterInterface "DBB702C3-77

witchId 256 type. The 19-4FE6-
charac broadcast A5AD-3A9C9E2
ters. domain 65309"
associated with
the port must
be specified.
This field
cannot be
updated.
connec No REFER For details, see Connection -

t ENCE Table 1-1068. interface
information.
connec No ARRAY For details, see IP address of ["192.168.1.1/2

tIp _REFER Table 1-1070. the 4"]
ENCE interconnection
port.
tenantI No string 0 to - Tenant ID. In "DBB702C3-77

d 256 the 19-4FE6-
charac northbound A5AD-3A9C9E2
ters. direction, the 65309"
value can be
either specified
or not. The
controller can
automatically
obtain the
tenant ID from
a logical router.
This field
cannot be
updated.


iMaster NCE-Fabric
Table 1-1067 LogicIfIpDto parameters

subnet No string 0 to - Subnet ID. "DBB702C3-77

Id 256 RouterInterface 19-4FE6-
charac is mandatory A5AD-3A9C9E2
ters. and 65309"
ConnectInterfa
ce is optional.
In the multi-
subnet
scenario, enter
a subnet ID list.
This field
cannot be
updated.
subnet No array< 0-255 - Subnet ID list, ["DBB702C3-7

Ids string> items. used for the 719-4FE6-
multi-subnet A5AD-3A9C9E2
scenario. Only 65309"]
RouterInterface
is supported.
This field
cannot be
updated.
ip No string 1 to - IP address of a "192.168.1.1/24

255 logical "
charac interface. For a
ters. broadcast
domain port,
the logical
switch must
have a
matching
subnet. For a
non-broadcast
domain port,
the upper-layer
system ensures
the accuracy of
interconnection
IP addresses.
This parameter
is mandatory
and can be
updated when
ConnectInterfa
ce is set.

iMaster NCE-Fabric
Table 1-1068 ConnectIfDto parameters

type Yes string 1 to 36 Dot1q Port "Dot1q"

charac connection
ters. type, which can
be Dot1q or
VxlanTunnel.
This field
cannot be
updated.
locatio Yes ARRAY For details, see Access -

n _REFER Table 1-1069. location. If
ENCE multiple ports
are specified,
intra-device
group ports
support the m-
lag or
independent
mode. For
inter-device
group ports,
the controller
automatically
generates the
logical switches
and adds the
two device
groups to the
same
broadcast
domain.
vlanId No int32 [1-409 - Access VLAN 10

4] ID. This
parameter is
mandatory
when the
access type is
dot1q. This
field cannot be
updated

iMaster NCE-Fabric

vniAllo No string 0 to - Alloc type, "Automatic"

cType 255 which can be
charac Automatic,
ters. Manual, or
Noalloc. This
field cannot be
updated.
vlanAll No string 0 to - Alloc type, "Noalloc"

ocType 255 which can be
charac Automatic,
ters. Manual, or
Noalloc. This
field cannot be
updated.
vni No int32 [1-160 - Interconnection 10

00000] VNI. This field
cannot be
updated.
subInt No int32 [1-409 - Sub-interface 2000

erface 4] number.
Num
peerVt No array< 0-255 - Peer VTEP IP ["192.168.1.1"]

epIp string> items. address. This
field cannot be
updated.
access No string - - Access mode, "Nni"

Mode which can be
UNI or NNI.
This field
cannot be
updated.
routeIn No boolea - - Whether the false

terface n routed
interface is
enabled. This
field cannot be
updated.

iMaster NCE-Fabric

arpDir No boolea - - Whether the false

teEnab policy
le generated by
VLINK routes is
enabled.
ndDire No boolea - - Whether the false

eEnabl policy
e generated by
VLINK routes is
enabled.
Table 1-1069 LogicIfLocationDto parameters

portNa No string 0 to - Port name. "portName"

me 255 Either the port
charac name or port
ters. ID can be set.
This field
cannot be
updated.
portId No string 0 to - Physical port. "DBB702C3-77

256 Either the port 19-4FE6-
charac name or port A5AD-3A9C9E2
ters. ID can be set. 65309"
This field
cannot be
updated.
deviceI No string 0 to - Physical device. "DBB702C3-77

d 256 Either the 19-4FE6-
charac device ID or A5AD-3A9C9E2
ters. device 65309"
management
IP address can
be set. This
field cannot be
updated.

iMaster NCE-Fabric


p 255 management
charac IP address.
ters. Either the
device ID or
the device
management
ID can be set.
This field
cannot be
updated.
Table 1-1070 ConnectIpDto parameters

localIp No string 1 to - Local IP "192.168.1.1/24

255 address of "
charac ConnectInterfa
ters. ce. This field
can be
updated.
peerIp No string 1 to - Remote IP "192.168.1.2/24

255 address of "
charac ConnectInterfa
ters. ce. This field
can be
updated.

iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 16:30:40"
charac
ters.

At 255 16:30:40"
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/interfaces HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"interface" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "logicInterfaceName",
"interfaceType" : "RouterInterface",
"mac" : "00:00:5E:00:01:01",
"ip" : {
"subnetId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"subnetIds" : ["DBB702C3-7719-4FE6-A5AD-3A9C9E265309"],
"ip" : "192.168.1.1/24"
},
"subIp" : ["192.168.1.1/24"],

iMaster NCE-Fabric
"connect" : {
"type" : "Dot1q",
"location" : [
{
"portName" : "portName",
"deviceIp" : "192.168.1.1"
}
],
"vlanId" : 10,
"vlanAllocType" : "Noalloc",
"vni" : 10,
"subInterfaceNum" : 2000,
"peerVtepIp" : ["192.168.1.1"],
"accessMode" : "Nni",
"ndDirectRouteEnable" : false
},
"connectIp" : ["192.168.1.1/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.7.2 Query Logical Interfaces
Typical Scenarios
The logical interface list needs to be queried.
Functions
Query logical interfaces based on the configuration source, logical switch (and
port type), or logical router.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/interfaces

produc No string 0 to 36 - Producer. This "CloudPlatform

er charac parameter is 1"
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric

isTrans No boolea - - Whether to -

it n query all
transit
interconnection
ports.
extern No string 0 to - ID of the "DBB702C3-77

alGate 256 external 19-4FE6-
wayId charac gateway. A5AD-3A9C9E2
ters. 65309"
logicS No string 0 to - Logical switch. "DBB702C3-77

witchId 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
interfa No string - - Port type. The "RouterInterfac

ceType options are as e"
follows:
RouterInterface
: broadcast
domain port.
ConnectInterfa
ce:
interconnection
port. This field
cannot be
updated.

dex

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/interfaces?
producer=CloudPlatform1&logicRouterId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&externalGatewayId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&interfaceType=RouterInterface&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1073 LogicInterfacePagedDtoWrapper parameters

eter t Value
interfa ARRAY For details, see Table Logical -

ce _REFER 1-1074. interface
ENCE information.


dex ]

ze ]
Table 1-1074 LogicInterfaceDto parameters

eter t Value

65309"
name string 1 to 255 - Object name. "logicInterface

characters. This field can Name"
be updated.


outerId characters. ID. This field 19-4FE6-
updated. 65309"
extern string 0 to 256 - ID of the "DBB702C3-77

alGate characters. external 19-4FE6-
wayId gateway. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
interfa string 0 to 255 - Port type. The "RouterInterfac

ceType characters. options are as e"
follows:
RouterInterface
: broadcast
domain port.
ConnectInterfa
ce:
interconnection
port. This field
cannot be
updated.
mac string 0 to 255 - MAC address "00:00:5E:

characters. of an interface 00:01:01"
in a broadcast
domain. The
value can be
changed.
ip REFER For details, see Table IP address of a -

ENCE 1-1075. logical
interface.
subIp array< - - Secondary IP ["192.168.1.1/2

string> address of an 4"]
interface. For
an interface in
a broadcast
domain, a
matching
subnet must
exist under the
logical switch.
This parameter
cannot be set
for an
interconnection
interface. The
value is a
character
string. The
value can be
changed.

iMaster NCE-Fabric

eter t Value
logicS string 0 to 256 - RouterInterface "DBB702C3-77

witchId characters. type. The 19-4FE6-
broadcast A5AD-3A9C9E2
domain 65309"
associated with
the port must
be specified.
This field
cannot be
updated.
connec REFER For details, see Table Connection -

t ENCE 1-1076. interface
information.
connec ARRAY For details, see Table IP address of ["192.168.1.1/2

tIp _REFER 1-1078. the 4"]
ENCE interconnection
port.
tenantI string 0 to 256 - Tenant ID. In "DBB702C3-77

d characters. the 19-4FE6-
northbound A5AD-3A9C9E2
direction, the 65309"
value can be
either specified
or not. The
controller can
automatically
obtain the
tenant ID from
a logical router.
This field
cannot be
updated.


iMaster NCE-Fabric
Table 1-1075 LogicIfIpDto parameters

eter t Value
subnet string 0 to 256 - Subnet ID. "DBB702C3-77

Id characters. RouterInterface 19-4FE6-
is mandatory A5AD-3A9C9E2
and 65309"
ConnectInterfa
ce is optional.
In the multi-
subnet
scenario, enter
a subnet ID list.
This field
cannot be
updated.
subnet array< 0-255 items. - Subnet ID list, ["DBB702C3-7

Ids string> used for the 719-4FE6-
multi-subnet A5AD-3A9C9E2
scenario. Only 65309"]
RouterInterface
is supported.
This field
cannot be
updated.
ip string 1 to 255 - IP address of a "192.168.1.1/24

characters. logical "
interface. For a
broadcast
domain port,
the logical
switch must
have a
matching
subnet. For a
non-broadcast
domain port,
the upper-layer
system ensures
the accuracy of
interconnection
IP addresses.
This parameter
is mandatory
and can be
updated when
ConnectInterfa
ce is set.

iMaster NCE-Fabric
Table 1-1076 ConnectIfDto parameters

eter t Value
type string 1 to 36 Dot1q Port "Dot1q"

characters. connection
type, which can
be Dot1q or
VxlanTunnel.
This field
cannot be
updated.
locatio ARRAY For details, see Table Access -

n _REFER 1-1077. location. If
ENCE multiple ports
are specified,
intra-device
group ports
support the m-
lag or
independent
mode. For
inter-device
group ports,
the controller
automatically
generates the
logical switches
and adds the
two device
groups to the
same
broadcast
domain.
vlanId int32 [1-4094] - Access VLAN 10

ID. This
parameter is
mandatory
when the
access type is
dot1q. This
field cannot be
updated

iMaster NCE-Fabric

eter t Value
vniAllo string 0 to 255 - Alloc type, "Automatic"

cType characters. which can be
Automatic,
Manual, or
Noalloc. This
field cannot be
updated.
vlanAll string 0 to 255 - Alloc type, "Noalloc"

ocType characters. which can be
Automatic,
Manual, or
Noalloc. This
field cannot be
updated.
vni int32 [1-16000000] - Interconnection 10

VNI. This field
cannot be
updated.
subInt int32 [1-4094] - Sub-interface 2000

erface number.
Num
peerVt array< 0-255 items. - Peer VTEP IP ["192.168.1.1"]

epIp string> address. This
field cannot be
updated.
access string - - Access mode, "Nni"

Mode which can be
UNI or NNI.
This field
cannot be
updated.
routeIn boolea - - Whether the false

terface n routed
interface is
enabled. This
field cannot be
updated.

iMaster NCE-Fabric

eter t Value

teEnab policy
le generated by
VLINK routes is
enabled.

eEnabl policy
e generated by
VLINK routes is
enabled.
Table 1-1077 LogicIfLocationDto parameters

eter t Value
portNa string 0 to 255 - Port name. "portName"

me characters. Either the port
name or port
ID can be set.
This field
cannot be
updated.
portId string 0 to 256 - Physical port. "DBB702C3-77

characters. Either the port 19-4FE6-
name or port A5AD-3A9C9E2
ID can be set. 65309"
This field
cannot be
updated.
deviceI string 0 to 256 - Physical device. "DBB702C3-77

d characters. Either the 19-4FE6-
device ID or A5AD-3A9C9E2
device 65309"
management
IP address can
be set. This
field cannot be
updated.

iMaster NCE-Fabric

eter t Value

IP address.
Either the
device ID or
the device
management
ID can be set.
This field
cannot be
updated.
Table 1-1078 ConnectIpDto parameters

eter t Value
localIp string 1 to 255 - Local IP "192.168.1.1/24

characters. address of "
ConnectInterfa
ce. This field
can be
updated.
peerIp string 1 to 255 - Remote IP "192.168.1.2/24

characters. address of "
ConnectInterfa
ce. This field
can be
updated.

iMaster NCE-Fabric

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.


Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"interface" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"mac" : "00:00:5E:00:01:01",
"ip" : {
"ip" : "192.168.1.1/24"
},
"subIp" : ["192.168.1.1/24"],

iMaster NCE-Fabric
"connect" : {
"type" : "Dot1q",
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
"vlanId" : 10,
"vni" : 10,
"peerVtepIp" : ["192.168.1.1"],
},
"connectIp" : ["192.168.1.1/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.7.3 Query a Layer 3 Logical Interface by ID
Typical Scenarios
A Layer 3 logical port needs to be queried by ID.
Functions
Query a Layer 3 logical port by ID.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/interfaces/interface/{id}


256 interface ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/interfaces/interface/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1081 LogicInterfaceListDtoWrapper parameters

eter t Value
interfa ARRAY For details, see Table Logical -

ce _REFER 1-1074. interface
ENCE information.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"interface" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"mac" : "00:00:5E:00:01:01",
"ip" : {
"ip" : "192.168.1.1/24"
},
"subIp" : ["192.168.1.1/24"],
"connect" : {
"type" : "Dot1q",
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
"vlanId" : 10,
"vni" : 10,
"peerVtepIp" : ["192.168.1.1"],
},
"connectIp" : ["192.168.1.1/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.7.4 Update a Logical Layer 3 Port
Typical Scenarios
A Layer 3 logical interface needs to be updated.
Functions
Update a Layer 3 logical port.
Constraints
HTTP Method
PUT
URI


charac network. This A5AD-3A9C9E2
updated.
Request Parameters


er ENCE Table 1-1065. updating a
Layer 3 logical
interface.

iMaster NCE-Fabric
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/interfaces/interface/DBB702C3-7719-4FE6-A5AD-3A9C9E266309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"interface" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"mac" : "00:00:5E:00:01:01",
"ip" : {
"ip" : "192.168.1.1/24"
},
"subIp" : ["192.168.1.1/24"],
"connect" : {
"type" : "Dot1q",
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
"vlanId" : 10,
"vni" : 10,
"peerVtepIp" : ["192.168.1.1"],
},
"connectIp" : ["192.168.1.1/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Response Parameters
LogicInterfaceListDtoWrapper parameters, For details, see Table 1-1081.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"interface" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"mac" : "00:00:5E:00:01:01",
"ip" : {
"ip" : "192.168.1.1/24"
},
"subIp" : ["192.168.1.1/24"],
"connect" : {
"type" : "Dot1q",
"location" : [
{
"deviceIp" : "192.168.1.1"
}
],
"vlanId" : 10,
"vni" : 10,
"peerVtepIp" : ["192.168.1.1"],
},
"connectIp" : ["192.168.1.1/24"],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.7.5 Delete a Layer 3 Logical Interface
Typical Scenarios
A Layer 3 logical port needs to be deleted.
Functions
Delete a Layer 3 logical port.
Constraints
The subnet bound on the GUI cannot be unbound using this API. You can unbind
the subnet by invoking the API for updating a logical switch.
HTTP Method
DELETE
URI


charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/interfaces/interface/DBB702C3-7719-4FE6-A5AD-3A9C9E265309?
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.8 Logical link Management

Description of logical link management interfaces:
1. Create a logical link.
2. Query the logical link information list.
3. Query logical link information.
4. Delete a logical link.
1.9.7.8.1 Create a Logical Link
Typical Scenarios
A logical link needs to be created.
Functions
Associate the logical switch with the logical router.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/links

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-1087. paramete
r
informati
on.
Table 1-1087 LinkDtoWrapper parameters

link Yes ARRAY 1 items. For Logical link -

_REFER details, see information.
ENCE Table 1-1088.

iMaster NCE-Fabric

id No string 0 to 36 - Logical link ID. "2711c7c3-

charac cec9-490e-
ters. b222-8bef7f23
36 9523"
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

logicS Yes string 0 to 36 - Logical switch "daa9a6bd-563

witchId charac ID. 4-4d86-89f9-7
ters. 3ee1085b270"
36
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

logicR Yes string 0 to 36 - Logical router "97e06d78-

outerId charac ID. f1f0-401e-8abe
ters. -831c67e41c15
36 "
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

logicN Yes string 0 to 36 - Logical "c321ed67-145

etwork charac network ID. 3-4726-85f8-7a
Id ters. 2ff56a19e2"
36
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.


iMaster NCE-Fabric


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 16:30:40"
charac
ters.

At 255 16:30:40"
charac
ters.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/links HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"link" : [
{
"id" : "2711c7c3-cec9-490e-b222-8bef7f239523",
"logicSwitchId" : "daa9a6bd-5634-4d86-89f9-73ee1085b270",
"logicRouterId" : "97e06d78-f1f0-401e-8abe-831c67e41c15",
"logicNetworkId" : "c321ed67-1453-4726-85f8-7a2ff56a19e2",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.8.2 Query the Logical Link Information List
Typical Scenarios
Information about all logical links needs to be queried.
Functions
Query the information list of all logical links.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/links

iMaster NCE-Fabric

produc No string 0 to 36 - producer. "default"

er charac
ters.
logicS No string 0 to 36 - Logical switch "daa9a6bd-563

witchId charac ID. 4-4d86-89f9-7
ters. 3ee1085b270"
logicR No string 0 to 36 - Logical router "97e06d78-

outerId charac ID. f1f0-401e-8abe
ters. -831c67e41c15
"
logicN No string 0 to 36 - Logical "c321ed67-145

etwork charac network ID. 3-4726-85f8-7a
Id ters. 2ff56a19e2"
pageIn No string 0 to - Page number. "1"

dex 255
charac
ters.
pageSi No string 0 to - Number of "1"

ze 255 records on
charac each page.
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/links?
producer=default&logicSwitchId=daa9a6bd-5634-4d86-89f9-73ee1085b270&logicRouterId=97e06d78-
f1f0-401e-8abe-831c67e41c15&logicNetworkId=c321ed67-1453-4726-85f8-7a2ff56a19e2&pageIndex=1&pa
geSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1091 LinkPagedDtoWrapper parameters

eter t Value
link ARRAY 0-4000 items. For details, Logical link -

ENCE

um ] of queried
logical links.
pageIn int32 [1-2147483647 - Page number. 1

dex ]
pageSi int32 [1-4000] - Number of 1

ze records on
each page.

eter t Value
id string 0 to 36 - Logical link ID. "2711c7c3-

value must 9523"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
logicS string 0 to 36 - Logical switch "daa9a6bd-563

witchId characters. 36 ID. 4-4d86-89f9-7
characters. The 3ee1085b270"
value must
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
logicR string 0 to 36 - Logical router "97e06d78-

outerId characters. 36 ID. f1f0-401e-8abe
characters. The -831c67e41c15
value must "
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
logicN string 0 to 36 - Logical "c321ed67-145

etwork characters. 36 network ID. 3-4726-85f8-7a
Id characters. The 2ff56a19e2"
value must
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.


iMaster NCE-Fabric

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.


Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"link" : [
{
"id" : "2711c7c3-cec9-490e-b222-8bef7f239523",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
],
"totalNum" : 200,
"pageIndex" : 1,

iMaster NCE-Fabric
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.8.3 Query Logical Link Information
Typical Scenarios
Logical link information needs to be queried.
Functions
Query logical link information.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/links/link/{id}

id Yes string 0 to - ID used for "DBB702C3-77

128 querying 19-4FE6-
charac tenant resource A5AD-3A9C9E2
ters. statistics. 65309"
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /controller/dc/v3/logicnetwork/links/link/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1095 LinkDtoWrapper parameters

eter t Value
link ARRAY 1 items. For details, see Logical link -

ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"link" : [
{
"id" : "2711c7c3-cec9-490e-b222-8bef7f239523",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.8.4 Delete a Logical Link
Typical Scenarios
A logical link needs to be deleted.
Functions
Disassociate the logical switch from the logical router.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/logicnetwork/links/link/{id}

id Yes string 0 to - Deletion by ID. "DBB702C3-77

128 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/links/link/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.9 End Port Management

# End port description:
1. Query the end port list.
2. Create an end port.
3. Query end ports by ID.
4. Update end ports by ID.
5. Delete end ports by ID.
1.9.7.9.1 Create an End Port
Typical Scenarios
An end port needs to be created. The following fields are mandatory: id, name,
and logicNetworkId.
Functions
Create an end port based on the request.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/endports
Request Parameters

er Range Value on

NCE 1-1098. s for
creating
an end
port.
Table 1-1098 EndPortsDtoWrapper parameters

endPor No REFER For details, see "" -

t ENCE Table 1-1099.
Table 1-1099 EndPortsDto parameters

id Yes string 0 to - End port ID. "DBB702C3-77

256 This field 19-4FE6-
logicPo No string 0 to - ID of the "DBB702C3-77

rtId 256 associated 19-4FE6-
charac logical port. A5AD-3A9C9E2
cannot be
updated.

iMaster NCE-Fabric

name No string 1 to - End port name. "name"

255 This field can
charac be updated.
ters.
descrip No string 0 to - ID of the "description"

tion 255 logical network
charac to which the
ters. end port
belongs. This
field cannot be
updated.

Id charac to which the A5AD-3A9C9E2
ters. end port 65309"
belongs. This
field cannot be
updated.
locatio No string 0 to - Location. This "10"

n 255 field can be
charac updated.
ters.
vmNa No string 0 to - Page size. "10"

me 255
charac
ters.
ipv4 No array< 0-1 - IPv4 address. ["192.168.1.1"]

string> items. The value can
be changed.
ipv6 No array< 0-1 - IPv6 address. ["FE80::a1"]

string> items. The value can
be changed.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/endports HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{

iMaster NCE-Fabric
"endPort" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"logicPortId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"location" : "10",
"vmName" : "10",
"ipv4" : ["192.168.1.1"],
"ipv6" : ["FE80::a1"]
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.9.2 Query All End Ports
Typical Scenarios
All end ports need to be queried.
Functions
Query all end ports under a specified condition.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/endports


ze 255
charac
ters.

dex 255 number.
charac
ters.

Id charac where the end A5AD-3A9C9E2
ters. port is located. 65309"

d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
produc No string 0 to 36 - default "default"

er charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/endports?
pageSize=10&pageIndex=1&logicNetworkId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&tenantId=DBB702C3-7719-4FE6-A5AD-3A9C9E265309&producer=default HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-1101 EndPortsDtoListWrapper parameters

eter t Value
endPor ARRAY 0-4000 items. For details, "" -

ts _REFER see Table 1-1102.
ENCE

um ] of query
results.
pageIn int32 [1-4000] - Page size. 1

dex

ze
Table 1-1102 QueryEndPortsDto parameters

eter t Value
id string 0 to 256 - End port ID. "DBB702C3-77

characters. This field 19-4FE6-
updated. 65309"
logicPo string 0 to 256 - ID of the "DBB702C3-77

rtId characters. associated 19-4FE6-
logical port. A5AD-3A9C9E2
This field 65309"
cannot be
updated.
name string 1 to 255 - End port name. "name"

be updated.
descrip string 0 to 255 - ID of the "description"

tion characters. logical network
to which the
end port
belongs. This
field cannot be
updated.

iMaster NCE-Fabric

eter t Value
logicN string 0 to 256 - ID of the "DBB702C3-77

etwork characters. logical network 19-4FE6-
Id to which the A5AD-3A9C9E2
end port 65309"
belongs. This
field cannot be
updated.
locatio string 0 to 255 - Location. This "10"

n characters. field can be
updated.
vmNa string 0 to 255 - Page size. "10"

me characters.
ipv4 array< 0-1 items. - IPv4 address. ["192.168.1.1"]

string> The value can
be changed.
ipv6 array< 0-1 items. - IPv6 address. ["FE80::a1"]

be changed.

65309"
type string - - Creation type, "Manually"

which can be
Manually or
Automatically.
This field
cannot be
updated.
access string - - Access mode, "Layer2"

Mode which can be
Layer 2 or
Layer 3. This
field cannot be
updated.

nal ENCE 1-1103.
advanc REFER For details, see Table "" -

e ENCE 1-1104.

iMaster NCE-Fabric

eter t Value
dnsAss ARRAY 0-65535 items. For "" -

ignme _REFER details, see Table 1-1105.
nt ENCE

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.


Table 1-1104 AdvanceDto parameters

eter t Value
vlan int32 [1-4094] - VLAN. 200
egress int32 [1-4094] - Egress VLAN. 200

Vlan
mac string 0 to 16000000 - MAC address. "00:00:5E:

characters. 00:01:01"

iMaster NCE-Fabric

eter t Value

alNetw characters. network ID. 19-4FE6-
orkId A5AD-3A9C9E2
65309"
ipv4Pr array< 0-32 items. - IPv4 prefix list. ["192.168.1.0/2

efixs string> 4"]
ipv6Pr array< 0-32 items. - IPv6 prefix list. ["FE80::/64"]

efixs string>
qosTe string - - QoS profile. "DBB702C3-77

mplate 19-4FE6-
A5AD-3A9C9E2
65309"
Table 1-1105 DnsAssignmentDto parameters

eter t Value
ipAddr string - - IP address. "192.168.1.1"

ess
hostNa string - - Host name. "hostName"

me
fqdn string - - Fully qualified "hostName.my

domain name company.com"
(FQDN), which
contains both
the host and
domain names
separated by
periods (.). For
example, if the
host name is
hostName and
the domain
name is
mycompany.co
m, the FQDN is
hostName.myc
ompany.com.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"endPorts" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"location" : "10",
"vmName" : "10",
"ipv4" : ["192.168.1.1"],
"ipv6" : ["FE80::a1"],
"type" : "Manually",
"accessMode" : "Layer2",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"advance" : {
"vlan" : 200,
"egressVlan" : 200,
"mac" : "00:00:5E:00:01:01",
"ipv4Prefixs" : ["192.168.1.0/24"],
"ipv6Prefixs" : ["FE80::/64"],
"qosTemplate" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
},
"dnsAssignment" : [
{
"ipAddress" : "192.168.1.1",
"hostName" : "hostName",
"fqdn" : "hostName.mycompany.com"
}
]
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.9.3 Query an End Port by ID
Typical Scenarios
Query an End Port by ID.
Functions
Query an end port by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/endports/endport/{id}

id Yes string 0 to - Query an end "DBB702C3-77

256 port by ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/endports/endport/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1107 QueryEndPortDtoWrapper parameters

eter t Value
endPor REFER For details, see Table "" -

t ENCE 1-1102.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"endPort" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"location" : "10",
"vmName" : "10",
"ipv4" : ["192.168.1.1"],
"ipv6" : ["FE80::a1"],
"type" : "Manually",
"accessMode" : "Layer2",
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
},
"advance" : {
"vlan" : 200,
"egressVlan" : 200,
"mac" : "00:00:5E:00:01:01",
"ipv4Prefixs" : ["192.168.1.0/24"],
"ipv6Prefixs" : ["FE80::/64"],
"qosTemplate" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
},
"dnsAssignment" : [
{
"ipAddress" : "192.168.1.1",
"hostName" : "hostName",
"fqdn" : "hostName.mycompany.com"
}
]
}
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.9.4 Update an End Port by ID
Typical Scenarios
An end port needs to be updated by ID. The fields that can be updated include
name, description, location, vmName, ipv4, and ipv6.
Functions
Update an end port by ID.
Constraints
HTTP Method
PUT
URI


256 an end port. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-1098. s for
updating
an end
port.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/endports/endport/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"endPort" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"location" : "10",
"vmName" : "10",
"ipv4" : ["192.168.1.1"],
"ipv6" : ["FE80::a1"]
}
}
Response Parameters
Table 1-1110 EndPortsDtoWrapper parameters

eter t Value
endPor REFER For details, see Table "" -

t ENCE 1-1111.

iMaster NCE-Fabric
Table 1-1111 EndPortsDto parameters

eter t Value
id string 0 to 256 - End port ID. "DBB702C3-77

characters. This field 19-4FE6-
updated. 65309"

rtId characters. associated 19-4FE6-
logical port. A5AD-3A9C9E2
This field 65309"
cannot be
updated.
name string 1 to 255 - End port name. "name"

be updated.
descrip string 0 to 255 - ID of the "description"

tion characters. logical network
to which the
end port
belongs. This
field cannot be
updated.
logicN string 0 to 256 - ID of the "DBB702C3-77

etwork characters. logical network 19-4FE6-
Id to which the A5AD-3A9C9E2
end port 65309"
belongs. This
field cannot be
updated.
locatio string 0 to 255 - Location. This "10"

n characters. field can be
updated.
vmNa string 0 to 255 - Page size. "10"

me characters.
ipv4 array< 0-1 items. - IPv4 address. ["192.168.1.1"]

be changed.
ipv6 array< 0-1 items. - IPv6 address. ["FE80::a1"]

be changed.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"endPort" : {
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"location" : "10",
"vmName" : "10",
"ipv4" : ["192.168.1.1"],
"ipv6" : ["FE80::a1"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.9.5 Delete an End Port by ID
Typical Scenarios
An end port needs to be deleted by ID.
Functions
ID for deleting an end port.
Constraints
HTTP Method
DELETE

iMaster NCE-Fabric
URI


256 an end port. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/endports/endport/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.10 Logical VAS

# Logical VAS API description:
1. Define services for logical VAS NEs.
2. Define services for logical VAS routes.
1.9.7.10.1 Create a Logical VAS NE
Typical Scenarios
A logical VAS NE needs to be created.
Functions
Create a logical VAS NE, such as a logical firewall or a logical LB.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/servicenetwork/vass
Request Parameters

vas Yes REFER For details, see Parameters for -

logical VAS NE.

iMaster NCE-Fabric
Table 1-1114 LogicVasDtoWrapper parameters

vas Yes ARRAY For details, see Logical VAS NE -

ENCE
Table 1-1115 LogicVasDto parameters

id Yes UUID - - Logical VAS NE "a915f8c1-

ID. d06f-46cd-
a968-38328e0a
b2d3"
name Yes string 1 to 31 - Logical VAS NE "logicfw1"

charac name.
ters.
descrip No string 0 to - Logical VAS NE "This is vas"

charac
ters.
type Yes string - - Logical VAS NE "Firewall"

type. Firewall:
firewall;
Paloalto: PA
firewall;
FirewallOutCon
trol: firewall
not managed
by the
controller.
logicN Yes UUID - - Logical "a915f8c1-

etwork network to d06f-46cd-
Id which a logical a968-38328e0a
VAS device b2d3"
belongs.

iMaster NCE-Fabric

logicR No UUID - - Logical router "a915f8c1-

outerId connected to a d06f-46cd-
logical VAS a968-38328e0a
device. This b2d3"
parameter is
mandatory
when the VAS
type is firewall
or
firewallOutCon
trol.
tenantI No UUID - - Tenant to "a915f8c1-

d which a logical d06f-46cd-
network a968-38328e0a
belongs. This b2d3"
parameter can
be obtained by
the controller.
design No string 1 to - vSYS object "logicfw2"

atedN 255 name of the
ame charac logical VAS NE.
ters.
ipv6En No boolea - - Whether IPv6 -

able n is enabled.
routeD No boolea - - Whether to -

eployD n disable route
isable deployment.
vaspoo No array< - - List of -

lId string> associated VAS
pool IDs.
autoG No boolea - - Whether to -

enerat n automatically
eLink create an
internal link.


iMaster NCE-Fabric


ters. condition.

At 255 0:11:16.000+00:
charac 00"
ters.

At 255 0:11:16.000+00:
charac 00"
ters.
Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/vass HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vas" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "logicfw1",
"description" : "This is vas",
"type" : "Firewall",
"logicNetworkId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"logicRouterId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"tenantId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"designatedName" : "logicfw2",
"vaspoolId" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Response Parameters

iMaster NCE-Fabric
Table 1-1117 LogicVasDtoWrapper parameters

eter t Value
vas ARRAY For details, see Table Logical VAS NE -

_REFER 1-1118. list.
ENCE
Table 1-1118 LogicVasDto parameters

eter t Value
id UUID - - Logical VAS NE "a915f8c1-

ID. d06f-46cd-
a968-38328e0a
b2d3"
name string 1 to 31 - Logical VAS NE "logicfw1"

characters. name.
descrip string 0 to 255 - Logical VAS NE "This is vas"

type string - - Logical VAS NE "Firewall"

type. Firewall:
firewall;
Paloalto: PA
firewall;
FirewallOutCon
trol: firewall
not managed
by the
controller.
logicN UUID - - Logical "a915f8c1-

VAS device b2d3"
belongs.

iMaster NCE-Fabric

eter t Value
logicR UUID - - Logical router "a915f8c1-

device. This b2d3"
parameter is
mandatory
when the VAS
type is firewall
or
firewallOutCon
trol.
tenantI UUID - - Tenant to "a915f8c1-

d which a logical d06f-46cd-
network a968-38328e0a
belongs. This b2d3"
parameter can
be obtained by
the controller.
design string 1 to 255 - vSYS object "logicfw2"

atedN characters. name of the
ame logical VAS NE.
ipv6En boolea - - Whether IPv6 -

able n is enabled.
routeD boolea - - Whether to -

eployD n disable route
isable deployment.
vaspoo array< - - List of -

lId string> associated VAS
pool IDs.
autoG boolea - - Whether to -

enerat n automatically
eLink create an
internal link.

nal ENCE 1-1119.

iMaster NCE-Fabric

eter t Value

condition.

00"

00"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vas" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"vaspoolId" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.10.2 Query the Logical VAS List
Typical Scenarios
The logical VAS list needs to be queried.
Functions
Query logical VAS device groups based on the configuration source, tenant, logical
network, logical router, and type.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/vass


ters. condition.
vasNa No string 0 to 36 - VAS name. "vas1"

me charac
ters.
tenantI No UUID - - Tenant ID. "a915f8c1-

d d06f-46cd-
a968-38328e0a
b2d3"
logicN No UUID - - Logical "a915f8c1-

VAS device b2d3"
belongs.

iMaster NCE-Fabric

logicR No UUID - - Logical router "a915f8c1-

device. b2d3"
type No string - - Logical VAS NE "Firewall"

list.

dex

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vass?producer=CloudPlatform1&vasName=vas1&tenantId=a915f8c1-
d06f-46cd-a968-38328e0ab2d3&logicNetworkId=a915f8c1-d06f-46cd-
a968-38328e0ab2d3&logicRouterId=a915f8c1-d06f-46cd-
a968-38328e0ab2d3&type=Firewall&pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1121 LogicVasListDtoWrapper parameters

eter t Value
vas ARRAY For details, see Table Logical VAS NE -

ENCE

um of results.
pageIn int64 - - Page index. 1

dex

iMaster NCE-Fabric

eter t Value
pageSi int64 - - Page size. 4000

ze
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vas" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"vaspoolId" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
],
"totalNum" : 100,
"pageIndex" : 1,
"pageSize" : 4000
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.10.3 Query a Logical VAS NE by ID
Typical Scenarios
A logical VAS NE needs to be queried by ID.

iMaster NCE-Fabric
Functions
Query a logical VAS NE by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/vass/vas/{id}


ID. d06f-46cd-
a968-38328e0a
b2d3"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
LogicVasDtoWrapper parameters, For details, see Table 1-1117.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vas" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"vaspoolId" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.10.4 Update a Logical VAS NE by ID
Typical Scenarios
Update a Logical VAS NE by ID.
Functions
Update a logical VAS NE by ID.
Constraints
HTTP Method
PUT

iMaster NCE-Fabric
URI


ID. d06f-46cd-
a968-38328e0a
b2d3"
Request Parameters

vas Yes REFER For details, see Parameters for -

logical VAS NE.
Sample Request
HTTP
PUT /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vas" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"vaspoolId" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}

iMaster NCE-Fabric
]
}
Response Parameters
LogicVasDtoWrapper parameters, For details, see Table 1-1117.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vas" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"vaspoolId" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.10.5 Delete a Logical VAS NE by ID
Typical Scenarios
A logical VAS NE needs to be deleted by ID.

iMaster NCE-Fabric
Functions
Delete a logical VAS NE by ID.
Constraints
HTTP Method
DELETE
URI


ID. d06f-46cd-
a968-38328e0a
b2d3"


er Controller-
MDC"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3?
producer=Agile-Controller-MDC HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.10.6 Query Southbound Configurations Based on VAS ID
Typical Scenarios
Logical VAS configurations need to be queried.
Functions
Query southbound configurations of a logical VAS.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/vass/vas/{id}/detail

iMaster NCE-Fabric

id Yes string - - Logical VAS ID. "a915f8c1-

d06f-46cd-
a968-38328e0a
b2d3"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3/detail HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1128 LogicVasConfigurationWrapper parameters

eter t Value
vas ARRAY For details, see Table Logical VAS -

_REFER 1-1129. configuration.
ENCE
Table 1-1129 LogicVasConfiguration parameters

eter t Value
deviceI string - - Device ID. "d6e575d5-3a8

d 6-393b-b312-
cf1936e7c212"
name string - - VAS name. "vsys_why11_5

058_1"
type string - - Type. "paloalto"

iMaster NCE-Fabric

eter t Value
vaspor ARRAY For details, see Table VAS port -

t _REFER 1-1130. configuration.
ENCE
staticR ARRAY For details, see Table route -

oute _REFER 1-1131. configuration
ENCE
Table 1-1130 VasPortConfiguration parameters

eter t Value
name string - - Interface name "ethernet1/11.

2002"
vlan int32 - - VLAN ID 2002
ipv4 string - - IPv4 address. "10.1.1.1/29"
ipv6 string - - IPv6 address. "FF80::1/126"
Table 1-1131 StaticRouteConfiguration parameters

eter t Value
destina string - - Destination IP "10.1.1.0/24"

tion address.
nextho string - - Next hop. "10.1.1.1"

p
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"vas" : [
{
"deviceId" : "d6e575d5-3a86-393b-b312-cf1936e7c212",
"name" : "vsys_why11_5058_1",
"type" : "paloalto",
"vasport" : [
{
"name" : "ethernet1/11.2002",
"vlan" : 2002,
"ipv4" : "10.1.1.1/29",
"ipv6" : "FF80::1/126"
}
],
"staticRoute" : [
{
"destination" : "10.1.1.0/24",
"nexthop" : "10.1.1.1"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.10.7 Query a Logical Link by ID on a Logical VAS Device
Typical Scenarios
A logical link needs to be queried by ID on a logical VAS device.
Functions
Query a logical link by ID on a logical VAS device.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/vass/vas/{id}/vaslink

iMaster NCE-Fabric

id Yes UUID - - Logical link ID. "a915f8c1-

d06f-46cd-
a968-38328e0a
b2d3"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3/vaslink HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1133 LogicVasLinkWrapper parameters

eter t Value
interna ARRAY For details, see Table Internal link -

llink _REFER 1-1134. list.
ENCE
extern ARRAY For details, see Table External link -

allink _REFER 1-1135. list.
ENCE
Table 1-1134 InternalLinkDto parameters

eter t Value
id UUID - - Internal link ID. "a915f8c1-

d06f-46cd-
a968-38328e0a
b2d3"

iMaster NCE-Fabric

eter t Value
name string 1 to 255 - Internal link "internal_link1"

characters. name.
routerI string 1 to 255 - IP address and "10.1.1.1/24"

p characters. mask for a
logical
interface on a
logical router.
vasIp string 1 to 255 - IP address and "10.1.1.1/24"

characters. mask for a
logical
interface on a
logical VAS
device.

characters. VLAN.
vaspor UUID - - VAS port ID. "a915f8c1-

tId d06f-46cd-
a968-38328e0a
b2d3"
routerI string 1 to 255 - Logical IPv6 "FE80:0000:000

pv6 characters. address of a 0:0000:0000:00
logical router. 44:0000:0032/1
27"

6 characters. a logical 0:0000:0000:00
interface on a 44:0000:0032/1
logical VAS 28"
device.
Table 1-1135 ExternalLinkDto parameters

eter t Value
id UUID - - External link "a915f8c1-

ID. d06f-46cd-
a968-38328e0a
b2d3"
name string 1 to 255 - External link "external_link1

characters. name. "

iMaster NCE-Fabric

eter t Value
extern UUID - - External "a915f8c1-

alGate gateway d06f-46cd-
wayId connected to a a968-38328e0a
logical VAS b2d3"
device.

alNetw network d06f-46cd-
orkId domain a968-38328e0a
connected to a b2d3"
logical VAS
device.

tId d06f-46cd-
a968-38328e0a
b2d3"

address on a 44:0000:0032/1
router. 27"

address on a 44:0000:0032/1
VAS device. 28"
ipv4Ac boolea - - Whether an -

cessExt n IPv4 address is
ernalE reachable to an
nable external
network.

nable external
network.

logical
interface on an
external
gateway.

iMaster NCE-Fabric

eter t Value

logical
interface on a
logical VAS
device.

characters. VLAN.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"internallink" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "internal_link1",
"routerIp" : "10.1.1.1/24",
"vasIp" : "10.1.1.1/24",
"vlan" : "100",
"vasportId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128"
}
],
"externallink" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "external_link1",
"externalGatewayId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"externalNetworkId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128",
"routerIp" : "10.1.1.1/30",
"vasIp" : "10.1.1.1/30",
"vlan" : "100"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.10.8 Create an Internal Link by ID on a Logical VAS Device
Typical Scenarios
An internal link needs to be created by ID on a logical VAS device.
Functions
Create an internal link by ID on a logical VAS device.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/servicenetwork/vass/vas/{id}/vaslink/internallinks


ID. d06f-46cd-
a968-38328e0a
b2d3"

iMaster NCE-Fabric
Request Parameters

interna Yes REFER For details, see Parameters for -

llink ENCE Table 1-1138. creating an
internal link on
a logical VAS
device.
Table 1-1138 InternalLinkWrapper parameters

interna Yes ARRAY For details, see Objects in an -

llink _REFER Table 1-1139. internal link
ENCE list.

id Yes UUID - - Internal link ID. "a915f8c1-

d06f-46cd-
a968-38328e0a
b2d3"
name Yes string 1 to - Internal link "internal_link1"

255 name.
charac
ters.
routerI Yes string 1 to - IP address and "10.1.1.1/24"

p 255 mask for a
charac logical
ters. interface on a
logical router.
vasIp Yes string 1 to - IP address and "10.1.1.1/24"

255 mask for a
charac logical
ters. interface on a
logical VAS
device.

iMaster NCE-Fabric

vlan Yes string 1 to - Interconnection "100"

255 VLAN.
charac
ters.
vaspor No UUID - - VAS port ID. "a915f8c1-

tId d06f-46cd-
a968-38328e0a
b2d3"
routerI No string 1 to - Logical IPv6 "FE80:0000:000

pv6 255 address of a 0:0000:0000:00
charac logical router. 44:0000:0032/1
ters. 27"

6 255 a logical 0:0000:0000:00
charac interface on a 44:0000:0032/1
ters. logical VAS 28"
device.
Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3/vaslink/
internallinks HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"internallink" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"routerIp" : "10.1.1.1/24",
"vasIp" : "10.1.1.1/24",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128"
}
]
}
Response Parameters

iMaster NCE-Fabric
Table 1-1140 InternalLinkWrapper parameters

eter t Value
interna ARRAY For details, see Table Objects in an -

llink _REFER 1-1134. internal link
ENCE list.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"internallink" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"routerIp" : "10.1.1.1/24",
"vasIp" : "10.1.1.1/24",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.10.9 Delete an Intenal Link
Typical Scenarios
An internal link needs to be deleted.
Functions
Delete an internal link based on the VAS NE ID and link ID.

iMaster NCE-Fabric
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/servicenetwork/vass/vas/{vasId}/vaslink/internallinks/internallink/
{id}

vasId Yes UUID - - Logical VAS NE "a915f8c1-

ID. d06f-46cd-
a968-38328e0a
b2d3"
id Yes UUID - - Internal link ID "a915f8c1-

of a logical d06f-46cd-
VAS NE. a968-38328e0a
b2d3"


er Controller-
MDC"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3/vaslink/
internallinks/internallink/a915f8c1-d06f-46cd-a968-38328e0ab2d3?producer=Agile-Controller-MDC HTTP/
1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.10.10 Add New Routes for a Logical VAS Device
Typical Scenarios
New routes need to be added for a logical VAS device.
Functions
Add new routes for a logical VAS device.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/controller/dc/v3/servicenetwork/vass/vas/{vasId}/routes

vasId Yes string 36 - Logical VAS NE "a915f8c1-

charac ID. d06f-46cd-
ters. a968-38328e0a
b2d3"
Request Parameters

er Range Value on

rs for VAS
route
transmissi
on.
Table 1-1145 VasRoutesDto parameters

routeId Yes string 0 to - Route ID. "a915f8c1-

255 d06f-46cd-
charac a968-38328e0a
ters. b2d3"
vasId No string 0 to 36 - Logical VAS NE "a915f8c1-

ters. a968-38328e0a
b2d3"
destina Yes array< Each - List of -

tion string> item destination
has 0 network
to 255 segments. The
charac value is a
ters. string.

iMaster NCE-Fabric

destRo Yes string 36 - Router ID. "a915f8c1-

uterId charac d06f-46cd-
ters. a968-38328e0a
b2d3"

Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3/routes HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routeId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"vasId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"destination" : [
"10.1.1.0/24"
],
"destRouterId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
Response Parameters
Table 1-1146 VasRoutesDto parameters

eter t Value
routeId string 0 to 255 - Route ID. "a915f8c1-

characters. d06f-46cd-
a968-38328e0a
b2d3"
vasId string 0 to 36 - Logical VAS NE "a915f8c1-

characters. ID. d06f-46cd-
a968-38328e0a
b2d3"

iMaster NCE-Fabric

eter t Value
destina array< Each item has 0 - List of -

tion string> to 255 destination
characters. network
segments. The
value is a
string.
destRo string 36 characters. - Router ID. "a915f8c1-

uterId d06f-46cd-
a968-38328e0a
b2d3"

nal ENCE 1-1119.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"destination" : [
"10.1.1.0/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.10.11 Query New Routes for a Logical VAS Device in Batches
Typical Scenarios
New routes need to be queried in batches for a logical VAS device.
Functions
Query new routes for a logical VAS device in batches.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/vass/routes

routeId No string 0 to - Route ID. "a915f8c1-

255 d06f-46cd-
ters. b2d3"
produc No string 0 to 36 - Provider. "Agile-

er charac Controller-
ters. MDC"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vass/routes?routeId=a915f8c1-d06f-46cd-
a968-38328e0ab2d3&producer=Agile-Controller-MDC HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-1148 VasRoutesQueryDto parameters

eter t Value
vasRou ARRAY For details, see Table List of VAS -

tes _REFER 1-1146. routes for
ENCE transmission.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vasRoutes" : [
{
"destination" : [
"10.1.1.0/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.10.12 Update New Routes for a Logical VAS Device
Typical Scenarios
New routes need to be updated for a logical VAS device.
Functions
Update new routes for a logical VAS device.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/servicenetwork/vass/vas/{vasId}/routes/{routeId}


ters. a968-38328e0a
b2d3"

255 d06f-46cd-
ters. b2d3"

iMaster NCE-Fabric
Request Parameters

er Range Value on

rs for VAS
route
transmissi
on.
Sample Request
HTTP
PUT /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3/routes/a915f8c1-
d06f-46cd-a968-38328e0ab2d3 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"destination" : [
"10.1.1.0/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
Response Parameters
VasRoutesDto parameters, For details, see Table 1-1146.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"destination" : [
"10.1.1.0/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.10.13 Delete New Routes from a Logical VAS Device
Typical Scenarios
New routes need to be deleted from a logical VAS device.
Functions
Delete new routes from a logical VAS device.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/servicenetwork/vass/vas/{vasId}/routes/{routeId}

iMaster NCE-Fabric


ters. a968-38328e0a
b2d3"

255 d06f-46cd-
ters. b2d3"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/servicenetwork/vass/vas/a915f8c1-d06f-46cd-a968-38328e0ab2d3/routes/
a915f8c1-d06f-46cd-a968-38328e0ab2d3 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.11 Logical Topology Management

Logical network O&M APIs:
1. Query information about device resources mapped to logical routers, logical

switches, logical ports, logical interfaces, and end points.
2. Specify the VXLAN tunnel list and VXLAN ingress replication table.
1.9.7.11.1 Query End Ports on VMs/BMs
Typical Scenarios
End ports on VMs/BMs need to be queried.
Functions
Query end ports on VMs/BMs based on a specified logical switch or physical
device.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/logictopo/endport

deviceI No string 0 to 36 - Port group ID. "10.23.15.1"

p charac
ters.
deviceI No string 0 to - Logical router "DBB702C3-77

d 256 ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric


witchId 256 ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

charac A5AD-3A9C9E2
ters. 65309"
endPor No string 0 to - Logical switch "DBB702C3-77

tId 256 ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
mac No string 0 to - MAC address "00:5E:

255 of a logical 00:63:96:95"
charac port.
ters.
ip No string 0 to - IP address of "192.168.1.1"

255 an end port.
charac
ters.
vmNa No string 0 to - Name. "vmPort"

me 255
charac
ters.
type No string - - End port type, "VM"

which can be
VM, BM, POD,
DYNAMIC.
hostNa No string 0 to - Host name. "hostName"

me 255
charac
ters.

dex 255
charac
ters.

ze 255
charac
ters.

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/logictopo/endport?deviceIp=10.23.15.1&deviceId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&logicRouterId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&endPortId=DBB702C3-7719-4FE6-A5AD-3A9C9E265309&mac=00:5E:
00:63:96:95&ip=192.168.1.1&vmName=vmPort&type=VM&hostName=hostName&pageIndex=1&pageSize=1
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1153 EndPortDtoWrapper parameters

eter t Value
endPor ARRAY For details, see Table "" -

t _REFER 1-1154.
ENCE

um ] of end ports.

dex ]

ze ]
Table 1-1154 EndPortDto parameters

eter t Value

A5AD-3A9C9E2
65309"

characters.

iMaster NCE-Fabric

eter t Value
mac string 1 to 255 - MAC address "00:5E:

characters. of an end port. 00:63:96:95"
vmNa string 0 to 255 - Name of the "vmname"

me characters. VM where an
end port is
located.
vmmN string 0 to 255 - VMM name. "vmmname"

ame characters.
vmmTy string 0 to 255 - VMM type. "Openstack"

pe characters.
hostNa string 0 to 255 - Host name. "hostname"

me characters.
type string 0 to 255 VM End port type. "VM"

characters. VM or BM.
device string - - Port type, "compute:nova

Owner which can be "
compute:nova
or
network:dhcp.
metaD string - - Meta data of "metaData"

ata an end port.
status string 0 to 255 DOWN End port "DOWN"

characters. status, which
can be UP,
DOWN, or
UNKNOWN.
connec ARRAY For details, see Table "" -

tPort _REFER 1-1155.
ENCE
ip ARRAY For details, see Table "" ["10.10.10.1"]

_REFER 1-1156.
ENCE
vlan int32 [1-16777215] - Broadcast 10

domain.
vni int32 [1-16777215] - VXLAN ID. 10
belong REFER For details, see Table "" -

Info ENCE 1-1157.

iMaster NCE-Fabric

eter t Value

Time characters. 16:30:40"

Time characters. 16:30:40"
names string 0 to 128 - Name space to "default"

pace characters. which K8s POD
belongs.
contai string 0 to 32 - K8s POD "RUNNING"

nerStat characters. running status.
us
Table 1-1155 ConnectPortDto parameters

eter t Value

A5AD-3A9C9E2
65309"
ifNam string 1 to 255 - Interface "ifname"

e characters. name.

IP address.
device string 1 to 255 - Connected "10GE1/0/10"

PortNa characters. physical port
me name.
device string 1 to 255 - Name of the "Device1"

Name characters. connected
device.

iMaster NCE-Fabric
Table 1-1156 IpDto parameters

eter t Value
ip string 0 to 256 - IP address. "DBB702C3-77

A5AD-3A9C9E2
65309"

Id characters. 19-4FE6-
A5AD-3A9C9E2
65309"
Table 1-1157 BelongInfoDto parameters

eter t Value

rtId characters. logical port 19-4FE6-
directly A5AD-3A9C9E2
connected to 65309"
the end port.
logicS string 0 to 256 - Logical switch. "DBB702C3-77

witchId characters. 19-4FE6-
A5AD-3A9C9E2
65309"
logicS string 1 to 255 - Logical switch "logicswitch1"

witchN characters. name.
ame

outerId characters. ID. 19-4FE6-
A5AD-3A9C9E2
65309"
logicR string 1 to 255 - Logical router "logicrouter1"

outerN characters. name.
ame
tenantI string 0 to 256 - Tenant ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
fabricI string 1 to 255 - Tenant name. "tenant1"

dNam characters.
e

iMaster NCE-Fabric

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
vpcNa string 1 to 255 - VPC name. "VPC1"

me characters.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"endPort" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"mac" : "00:5E:00:63:96:95",
"vmName" : "vmname",
"vmmName" : "vmmname",
"vmmType" : "Openstack",
"hostName" : "hostname",
"type" : "VM",
"deviceOwner" : "compute:nova",
"status" : "DOWN",
"connectPort" : [
{
"ifName" : "ifname",
"deviceIp" : "192.168.1.1",
"devicePortName" : "10GE1/0/10",
"deviceName" : "Device1"

iMaster NCE-Fabric
}
],
"ip" : ["10.10.10.1"],
"vlan" : 10,
"vni" : 10,
"belongInfo" : {
"logicSwitchName" : "logicswitch1",
"logicRouterName" : "logicrouter1",
"fabricIdName" : "tenant1",
"vpcName" : "VPC1"
},
"createTime" : "2017-08-10 16:30:40",
"updateTime" : "2017-08-10 16:30:40",
"namespace" : "default",
"containerStatus" : "RUNNING"
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.11.2 Query the Device Mapping Information of All Logical Interfaces
Typical Scenarios
The device mapping information of all logical ports needs to be queried based on
a specified condition.
Functions
Query the device mapping information of all logical interfaces based on a
specified device (with a specified logical router and interface type), a specified
logical router, and a specified logical interface.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v3/logicnetwork/logictopo/interface-map

deviceI No string 0 to 36 - Logical router "192.168.1.1"

p charac ID.
ters.
deviceI No string 0 to - Logical "DBB702C3-77

d 256 interface. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

charac A5AD-3A9C9E2
ters. 65309"
logicIn No string 0 to - Logical "DBB702C3-77

terface 256 interface. 19-4FE6-
Id charac A5AD-3A9C9E2
ters. 65309"
interfa No string - - Port type. The "ConnectInterf

ceType options are as ace"
follows:
RouterInterface
: broadcast
domain port.
ConnectInterfa
ce:
interconnection
port. This field
cannot be
updated.

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/logictopo/interface-map?
deviceIp=192.168.1.1&deviceId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&logicInterfaceId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&interfaceType=ConnectInterface&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1159 GetIfByConditionWrapper parameters

eter t Value
interfa ARRAY For details, see Table "" -

ce _REFER 1-1160.
ENCE


dex ]

ze ]
Table 1-1160 GetIfByConditionDto parameters

eter t Value

A5AD-3A9C9E2
65309"

characters.

outerId characters. ID. 19-4FE6-
A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
interfa string 0 to 255 Connec Port type. The "ConnectInterf

ceType characters. tInterfa options are as ace"
ce follows:
RouterInterface
: broadcast
domain port.
ConnectInterfa
ce:
interconnection
port. This field
cannot be
updated.
logicR string 1 to 255 - Management "router1"

outerN characters. IP address of a
ame device.
vrfNa string 1 to 255 - Logical router "vrf1"

logicS string 0 to 256 - Logical switch. "DBB702C3-77

witchId characters. 19-4FE6-
A5AD-3A9C9E2
65309"
logicS string 0 to 255 - Logical switch "switch1"

ame
physic ARRAY For details, see Table "" -

alIfList _REFER 1-1161.
ENCE
Table 1-1161 PhysicalPortDto parameters

eter t Value

A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
ifname string 0 to 255 - Name of a "ifName1"

characters. Layer 2 sub-
interface
corresponding
to the logical
port.
ifstatu string - DOWN Device port "DOWN"

s status, which
can be UP or
DOWN.

IP address.
device string 1 to 255 - Name of the "devicePort1"

PortNa characters. physical port
me corresponding
to the logical
port.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"interface" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"interfaceType" : "ConnectInterface",
"logicRouterName" : "router1",
"vrfName" : "vrf1",
"logicSwitchName" : "switch1",
"physicalIfList" : [
{
"ifname" : "ifName1",
"ifstatus" : "DOWN",
"deviceIp" : "192.168.1.1",

iMaster NCE-Fabric
"devicePortName" : "devicePort1"
}
]
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.11.3 Query the Device Mapping Information of All Logical Ports
Typical Scenarios
The device mapping information of all logical ports needs to be queried based on
a specified condition.
Functions
Query the device mapping information of all logical ports based on a specified
device (with a logical switch), a specified logical switch, and a specified logical
port.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/logictopo/port-map

iMaster NCE-Fabric

deviceI No string 0 to 36 - Device "192.168.1.1"

p charac management
ters. IP address.
Either the
device ID or
the device
management
ID can be set.
This field
cannot be
updated.
deviceI No string 0 to - Device "DBB702C3-77

d 256 management 19-4FE6-
charac ID. Either the A5AD-3A9C9E2
ters. device 65309"
management
ID or device ID
can be set.
logicPo No string 0 to - Logical port ID. "DBB702C3-77

rtId 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

charac A5AD-3A9C9E2
ters. 65309"

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/logictopo/port-map?

iMaster NCE-Fabric
A5AD-3A9C9E265309&logicPortId=DBB702C3-7719-4FE6-
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1163 LogicPortPhysicalMapDtoWrapper parameters

eter t Value
port ARRAY For details, see Table "" -

_REFER 1-1164.
ENCE


dex ]

ze ]
Table 1-1164 LogicPortPhysicalMapDto parameters

eter t Value

A5AD-3A9C9E2
65309"
name string 1 to 255 - Object name. "name1"

characters.
bridge int32 [1-16777215] - Broadcast 10

Domai domain.
nId
logicS string 0 to 256 - Logical switch "DBB702C3-77

witchId characters. ID. 19-4FE6-
A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
logicS string 1 to 255 - Logical switch "switch1"

ame
physic ARRAY For details, see Table "" -

alPortli _REFER 1-1161.
st ENCE
endPor ARRAY For details, see Table "" -

t _REFER 1-1165.
ENCE
Table 1-1165 EndPortDtoPhy parameters

eter t Value
endPor string 0 to 256 - End port ID. "DBB702C3-77

tId characters. 19-4FE6-
A5AD-3A9C9E2
65309"
endPor string 1 to 255 - End port IP "192.168.1.1"

tIp characters. address.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"port" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name1",
"bridgeDomainId" : 10,
"logicSwitchName" : "switch1",
"physicalPortlist" : [
{
"ifname" : "ifName1",

iMaster NCE-Fabric
"ifstatus" : "DOWN",
"deviceIp" : "192.168.1.1",
"devicePortName" : "devicePort1"
}
],
"endPort" : [
{
"endPortIp" : "192.168.1.1"
}
]
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.11.4 Query the Device Mapping Information of All Logical Routers Based on a
Specified Condition
Typical Scenarios
The device mapping information of all logical routers needs to be queried based
on a specified condition.
Functions
Query the device mapping information of all logical routers based on a specified
device (with a logical router) or a specified logical router.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/logictopo/router-map

iMaster NCE-Fabric

deviceI No string 0 to 36 - Logical router "192.168.1.1"

p charac ID.
ters.

ters. device 65309"
management
ID or device ID
can be set.

charac A5AD-3A9C9E2
ters. 65309"

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/logictopo/router-map?
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1167 LogicRouterDtoListWrapper parameters

eter t Value
router ARRAY For details, see Table "" -

_REFER 1-1168.
ENCE

um ] of queried
logical routers.

dex ]

ze ]
Table 1-1168 LogicRouterDto parameters

eter t Value
vrfNa string 0 to 255 - VRF name of a "vrfName"

me characters. logical router.
import array< - - Import RT of ["10:111"]

argets on a logical
router. The
value is a
string.
name string 1 to 255 - Logical router "name"

characters. name.
id string 0 to 256 - Logical router "DBB702C3-77

A5AD-3A9C9E2
65309"
vni int32 [1-16000000] - VNI of a logical 10

router.

argets a logical
switch. The
value is a
string.

iMaster NCE-Fabric

eter t Value

List _REFER 1-1169.
ENCE
fabricL ARRAY For details, see Table "" -

ist _REFER 1-1170.
ENCE
Table 1-1169 DeviceListDto parameters

eter t Value

GroupI characters. ID of a physical 19-4FE6-
d device. A5AD-3A9C9E2
65309"

A5AD-3A9C9E2
65309"

IP address.
routeD string [0-255] - Logical router "RD"

istingui RD.
sher
Table 1-1170 FabricListDto parameters

eter t Value

A5AD-3A9C9E2
65309"
fabricI string 1 to 255 - Fabric name. "fabricId1"

dNam characters.
e

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"router" : [
{
"importRouteTargets" : ["10:111"],
"name" : "name",
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vni" : 10,
"exportRouteTargets" : ["10:111"],
"deviceList" : [
{
"deviceIp" : "192.168.1.1",
"routeDistinguisher" : "RD"
}
],
"fabricList" : [
{
"fabricIdName" : "fabricId1"
}
]
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.11.5 Query the Device Mapping Information of All Logical Switches
Typical Scenarios
The device mapping information of all logical switches needs to be queried based
on a specified condition.
Functions
Query the device mapping information of all logical switches based on a specified
condition.

iMaster NCE-Fabric
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/logictopo/switch-map

deviceI No string 0 to 36 - Device "192.168.1.1"

p charac management
ters. IP address.
Either the
device ID or
the device
management
ID can be set.
This field
cannot be
updated.

ters. device 65309"
management
ID or device ID
can be set.

charac A5AD-3A9C9E2
ters. 65309"

dex 255
charac
ters.

ze 255
charac
ters.

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/logictopo/switch-map?
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1172 LogicSwitchDevicemapDtoWrapper parameters

eter t Value
switch ARRAY For details, see Table "" -

_REFER 1-1173.
ENCE

um ] of logical
switches.

dex ]

ze ]
Table 1-1173 LogicSwitchDevicemapDto parameters

eter t Value
id string 0 to 256 - Logical switch "DBB702C3-77

A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
import array< Each item has 0 - Import RT of ["10:111"]

RouteT string> to 255 the BGP EVPN
argets characters. on a logical
switch. The
value is a
string.
name string 1 to 255 - Logical switch "name1"

characters. name.
bridge int32 [0-16777215] - Bridge domain 10

Domai ID.
nId

VNI.

RouteT string> Each item has 0 the BGP EVPN
argets to 255 a logical
characters. switch. The
value is a
string.

List _REFER 1-1169.
ENCE
fabricL ARRAY For details, see Table "" -

ist _REFER 1-1170.
ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"switch" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"importRouteTargets" : ["10:111"],

iMaster NCE-Fabric
"name" : "name1",
"bridgeDomainId" : 10,
"vni" : 10,
"exportRouteTargets" : ["10:111"],
"deviceList" : [
{
"deviceIp" : "192.168.1.1",
"routeDistinguisher" : "RD"
}
],
"fabricList" : [
{
"fabricIdName" : "fabricId1"
}
]
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.11.6 Query VXLAN Tunnels
Typical Scenarios
VXLAN tunnels need to be queried by device.
Functions
Query VXLAN tunnels by device.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/logictopo/vxlan-tunnels

iMaster NCE-Fabric

deviceI No string 0 to 36 - Query All "192.168.1.1"

p charac VXLAN Ingress
ters. Replication
Tables

ters. device 65309"
management
ID or device ID
can be set.

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/logictopo/vxlan-tunnels?
deviceIp=192.168.1.1&deviceId=DBB702C3-7719-4FE6-A5AD-3A9C9E265309&pageIndex=1&pageSize=1
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1175 VxlanTunnelDtoWrapper parameters

eter t Value
vxlanT ARRAY For details, see Table "" -

unnels _REFER 1-1176.
ENCE

um ] of VXLAN
tunnels.

dex ]

ze ]
Table 1-1176 VxlanTunnelDto parameters

eter t Value
status string 0 to 255 DOWN VXLAN tunnel "DOWN"

characters. status, which
can be UP,
DOWN,
ERROR, or
UNKNOWN.
peerVt string 0 to 255 - Peer VTEP IP "192.168.1.1"

epIp characters. address.
localVt string 1 to 255 - Source VTEP IP "192.168.1.2"

Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{

iMaster NCE-Fabric
"vxlanTunnels" : [
{
"status" : "DOWN",
"peerVtepIp" : "192.168.1.1",
"localVtepIp" : "192.168.1.2"
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.11.7 Query All VXLAN Ingress Replication Tables
Typical Scenarios
VXLAN ingress replication tables need to be queried by device.
Functions
Query all VXLAN ingress replication tables by device.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/logictopo/vni-peers

deviceI No string 0 to 36 - Total number "192.168.1.1"

p charac of end ports.
ters.

iMaster NCE-Fabric

deviceI No string 0 to - Object ID. "DBB702C3-77

d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/logictopo/vni-peers?
deviceIp=192.168.1.1&deviceId=DBB702C3-7719-4FE6-A5AD-3A9C9E265309&pageIndex=1&pageSize=1
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1178 VniPeerDtoWrapper parameters

eter t Value
vniPee ARRAY For details, see Table "" -

r _REFER 1-1179.
ENCE

um ] of VNI peers.

dex ]

iMaster NCE-Fabric

eter t Value

ze ]
Table 1-1179 VniPeerDto parameters

eter t Value
localVt string 1 to 255 - Source VTEP IP "192.168.1.1"

vni int64 [1-16000000] - VNI. 10
peerVt string 1 to 255 - Destination "192.168.1.2"

epIp characters. VTEP IP
address.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vniPeer" : [
{
"localVtepIp" : "192.168.1.1",
"vni" : 10,
"peerVtepIp" : "192.168.1.2"
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 1
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.12 Logical Topology

# Logical topology APIs for querying VAS devices
1.9.7.12.1 Query Device Information Based on Conditions
Typical Scenarios
Devices need to be queried.
Functions
Query the device mapping information of all logical VAS devices based on a
specified condition, such as a logical VAS device, logical router, or specified device.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/logictopo/vas-map

logicV No UUID - - ID of a "DBB702C3-77

asId specified 19-4FE6-
logical VAS. A5AD-3A9C9E2
6530"
logicR No UUID - - Logical router "DBB702C3-77

outerId ID 19-4FE6-
A5AD-3A9C9E2
6530"

iMaster NCE-Fabric


p 255 management
charac IP address.
ters. Either the
device ID or
the device
management
ID can be set.
This field
cannot be
updated.
deviceI No UUID - - Device ID. "DBB702C3-77

d Either the 19-4FE6-
device ID or A5AD-3A9C9E2
device 6530"
management
IP address can
be set.

dex number.

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/logictopo/vas-map?logicVasId=DBB702C3-7719-4FE6-
A5AD-3A9C9E26530&deviceIp=172.16.0.1&deviceId=DBB702C3-7719-4FE6-
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1181 LogicVASDevicemapsDto parameters

eter t Value
vas ARRAY For details, see Table - -

_REFER 1-1182.
ENCE

um of results.

dex

ze
Table 1-1182 LogicVASDevicemapDto parameters

eter t Value
deviceI ARRAY For details, see Table Device -

nfo _REFER 1-1183. information
ENCE list.
logicR UUID - - Logical router "CCB702C3-77

outerId connected to a 19-4FE6-
logical VAS A5AD-3A9C9E2
device. This 65309"
parameter is
mandatory
when the VAS
type is firewall
or
firewallOutCon
trol.
vrfNa string 0 to 255 - VRF name "tenant1_route

me characters. corresponding r1_1"
to a logical
router.
id UUID - - VAS object ID. "CCB702C3-77

19-4FE6-
A5AD-3A9C9E2
65309"
name string 1 to 31 - VAS object "logicfw1"

characters. name.

iMaster NCE-Fabric

eter t Value
type string 1 to 255 - Logical VAS NE "Firewall"

characters. list.
vsysNa string 0 to 255 - Virtual system "vsys1"

me characters. name, which is
valid only
when the
logical VAS
type is firewall.
fabricD ARRAY For details, see Table Device -

eviceIn _REFER 1-1184. information list
fo ENCE on the fabric
side.
interna ARRAY For details, see Table Physical -

llink _REFER 1-1185. information list
ENCE of internal link
mapping.
extern ARRAY For details, see Table Physical -

allink _REFER 1-1188. information list
ENCE of external link
mapping.
Table 1-1183 VasDeviceInfoDto parameters

eter t Value
vasPoo UUID - - VAS resource "CBB702C3-77

lId pool. 19-4FE6-
A5AD-3A9C9E2
65309"
deviceI UUID - - Device "CBB702C3-77

d management 19-4FE6-
IP address. A5AD-3A9C9E2
65309"

IP address.

iMaster NCE-Fabric
Table 1-1184 FabricDeviceInfoDto parameters

eter t Value
router UUID - - Device "BB702C3-7719

DeviceI management -4FE6-
d IP address. A5AD-3A9C9E2
65309"
router string 0 to 255 - Device "10.1.1.1"

DeviceI characters. management
p IP address.
fabricI string 0 to 255 - Fabric ID. "BB702C3-7719

d characters. -4FE6-
A5AD-3A9C9E2
65309"
device string 0 to 255 - Device group "BB702C3-7719

GroupI characters. ID. -4FE6-
d A5AD-3A9C9E2
65309"
Table 1-1185 DeviceInternalLinkDto parameters

eter t Value
interna ARRAY For details, see Table Internal link -

llink _REFER 1-1186. set.
ENCE
vasIfN string 0 to 255 - Interface name "vlanif100"

ame characters. on a logical
VAS device.
routerI string 0 to 255 - Interface name "vBDIF100"

fName characters. on a logical
router.
link ARRAY For details, see Table Physical link -

_REFER 1-1187. set.
ENCE

iMaster NCE-Fabric

eter t Value
id UUID - - Internal link ID. "a915f8c1-

d06f-46cd-
a968-38328e0a
b2d3"
name string 1 to 255 - Internal link "internal_link1"

characters. name.

logical
interface on a
logical router.

logical
interface on a
logical VAS
device.

characters. VLAN.

tId d06f-46cd-
a968-38328e0a
b2d3"
routerI string 1 to 255 - Logical IPv6 "FE80:0000:000

pv6 characters. address of a 0:0000:0000:00
logical router. 44:0000:0032/1
27"

6 characters. a logical 0:0000:0000:00
interface on a 44:0000:0032/1
logical VAS 28"
device.

iMaster NCE-Fabric

eter t Value
deviceI UUID - - Device ID on a "CCB702C3-77

d VAS NE. 19-4FE6-
A5AD-3A9C9E2
65309"

IP address.
port string 0 to 255 - Port name. "ETH-TRUNK

characters. 10"
fabricD UUID - - Device name "CDD702C3-77

eviceId on a fabric 19-4FE6-
device. A5AD-3A9C9E2
65311"
fabricD string 0 to 255 - Device "172.16.0.2"

eviceIp characters. management
IP address on a
fabric device.
fabricP string 0 to 255 - Port name on a "ETH-TRUNK

ort characters. fabric device. 10"
Table 1-1188 DeviceExternalLinkDto parameters

eter t Value
extern ARRAY For details, see Table External link -

allink _REFER 1-1189. set.
ENCE
vasIfN string 0 to 255 - Interface name "vlanif100"

ame characters. on a logical
VAS device.
routerI string 0 to 255 - Interface name "vBDIF100"

fName characters. on a logical
router.

iMaster NCE-Fabric

eter t Value
extern string 0 to 255 - Virtual system "vBDIF100"

alVsys characters. name, which is
Name valid only
when the
logical VAS
type is firewall.
link ARRAY For details, see Table Physical link -

_REFER 1-1187. set.
ENCE
Table 1-1189 ExternalLinkDto parameters

eter t Value
id UUID - - External link "a915f8c1-

ID. d06f-46cd-
a968-38328e0a
b2d3"
name string 1 to 255 - External link "external_link1

characters. name. "

alGate gateway d06f-46cd-
wayId connected to a a968-38328e0a
logical VAS b2d3"
device.

alNetw network d06f-46cd-
orkId domain a968-38328e0a
connected to a b2d3"
logical VAS
device.

tId d06f-46cd-
a968-38328e0a
b2d3"

address on a 44:0000:0032/1
router. 27"

iMaster NCE-Fabric

eter t Value

address on a 44:0000:0032/1
VAS device. 28"

nable external
network.

nable external
network.

logical
interface on an
external
gateway.

logical
interface on a
logical VAS
device.

characters. VLAN.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"vas" : [
{
"deviceInfo" : [
{
"vasPoolId" : "CBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceId" : "CBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceIp" : "172.16.0.1"
}
],
"logicRouterId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vrfName" : "tenant1_router1_1",
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"vsysName" : "vsys1",
"fabricDeviceInfo" : [
{
"routerDeviceId" : "BB702C3-7719-4FE6-A5AD-3A9C9E265309",
"routerDeviceIp" : "10.1.1.1",
"fabricId" : "BB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceGroupId" : "BB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
],
"internallink" : [
{
"internallink" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"routerIp" : "10.1.1.1/24",
"vasIp" : "10.1.1.1/24",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128"
}
],
"vasIfName" : "vlanif100",
"routerIfName" : "vBDIF100",
"link" : [
{
"deviceId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceIp" : "172.16.0.1",
"port" : "ETH-TRUNK 10",
"fabricDeviceId" : "CDD702C3-7719-4FE6-A5AD-3A9C9E265311",
"fabricDeviceIp" : "172.16.0.2",
"fabricPort" : "ETH-TRUNK 10"
}
]
}
],
"externallink" : [
{
"externallink" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "external_link1",
"externalGatewayId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"externalNetworkId" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128",
"routerIp" : "10.1.1.1/30",
"vasIp" : "10.1.1.1/30",
"vlan" : "100"
}
],
"vasIfName" : "vlanif100",

iMaster NCE-Fabric
"routerIfName" : "vBDIF100",
"externalVsysName" : "vBDIF100",
"link" : [
{
"deviceId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceIp" : "172.16.0.1",
"port" : "ETH-TRUNK 10",
"fabricDeviceId" : "CDD702C3-7719-4FE6-A5AD-3A9C9E265311",
"fabricDeviceIp" : "172.16.0.2",
"fabricPort" : "ETH-TRUNK 10"
}
]
}
]
}
],
"totalNum" : 100,
"pageIndex" : 1,
"pageSize" : 4000
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.13 Logical Topology (Not Recommended)

# Description of logical interfaces:
1. Query the information about a logical port
2. Query information about a logical router
3. Query the logical switch list
4. Query subnet information
5. Logical port mapping
6. Query the tenant list
1.9.7.13.1 Query the Information About the Logical Port Pair
Typical Scenarios
A logical port pair needs to be queried.
Functions
Query information about logical port pairs based on conditions.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/acdcn/v3/gbpapi/getLogicportpeers
Request Parameters

er Range Value on
input REFERE For details, see Table Query -

NCE 1-1191. criteria of
logical
port pairs.
It is an
input
paramete
r model
class.
Table 1-1191 PortPeerDtoWrapper parameters

logicPo No array< Each - ID of a logical -

rtIdList string> item port.
has 1
to 36
charac
ters.
endPor No array< Each - ID of the user -

tIdList string> item port.
has 1
to 36
charac
ters.
logicS No array< Each - ID of a logical -

witchId string> item switch.
List has 1
to 36
charac
ters.

iMaster NCE-Fabric
Sample Request
HTTP
POST /acdcn/v3/gbpapi/getLogicportpeers HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"logicPortIdList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"endPortIdList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"logicSwitchIdList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
Response Parameters
Table 1-1192 PortPeerListDtoWrapper parameters

eter t Value
portPe ARRAY For details, see Table - -

erList _REFER 1-1193.
ENCE
portPe int32 - - Total number. 20

erTotal
Num
Table 1-1193 PortPeerDto parameters

eter t Value
logicPo UUID 1 to 36 - ID of a logical "DBB702C3-77

rtId characters. port. 19-4FE6-
A5AD-3A9C9E2
65309"
logicPo string - - - -
rtNam
e

iMaster NCE-Fabric

eter t Value
endPor UUID 1 to 36 - ID of the user "DBB702C3-77

tId characters. port. 19-4FE6-
A5AD-3A9C9E2
65309"
endPor string - - Name of the "endPort"

tName end port.
endPor int32 - - Type of the 1

tType end port. The
value 1
indicates
automatic
creation, and
the value 2
indicates
manual
creation.
endPor string 1 to 36 - IP address of "10.168.11.22"

tIp characters. the user port.
endPor string 1 to 255 - MAC address "10"

tMac characters. of an end port.
endPor int32 - - VLAN ID of the 2000

tVlanId end port.
endPor string 1 to 255 - Returned host "Host1"

tHostN characters. name when
ame the end port is
a VM or BM.
endPor UUID 1 to 36 - Returned host "DBB702C3-77

tHostI characters. ID when the 19-4FE6-
d end port is a A5AD-3A9C9E2
VM or BM. 65309"
endPor string 1 to 255 - Returned VM "Vm1"

tVMNa characters. name when
me the end port is
a VM.
logicS UUID 1 to 36 - ID of a logical "DBB702C3-77

witchId characters. switch. 19-4FE6-
A5AD-3A9C9E2
65309"

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"portPeerList" : [
{
"endPortName" : "endPort",
"endPortType" : 1,
"endPortIp" : "10.168.11.22",
"endPortMac" : "10",
"endPortVlanId" : 2000,
"endPortHostName" : "Host1",
"endPortHostId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"endPortVMName" : "Vm1",
"logicSwitchId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
],
"portPeerTotalNum" : 20
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.13.2 Query Logical Router Information
Typical Scenarios
Logical router information needs to be queried.
Functions
Query logical router information based on conditions.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/acdcn/v3/gbpapi/getLogicrouters
Request Parameters

er Range Value on

NCE 1-1195. router
query
criteria,
which is
an input
paramete
r model
class.

logicR No array< Each - ID of a logical -

outerId string> item router.
List has 1
to 36
charac
ters.
tenantI No UUID 1 to 36 - Tenant ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
Sample Request
HTTP
POST /acdcn/v3/gbpapi/getLogicrouters HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"logicRouterIdList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],

iMaster NCE-Fabric
"tenantId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
Response Parameters
Table 1-1196 LogicRouterDtoListWrapper parameters

eter t Value
logicR ARRAY For details, see Table - -

outerLi _REFER 1-1197.
st ENCE
Table 1-1197 LogicRouterDto parameters

eter t Value
logicR UUID 1 to 36 - ID of a logical "DBB702C3-77

outerId characters. router. 19-4FE6-
A5AD-3A9C9E2
65309"
logicR string 1 to 255 - Name of a "router1"

outerN characters. logical router.
ame
vrfNa string 1 to 255 - VRF name. "Vrf1"

me characters.
vni int64 - - - -
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"logicRouterList" : [
{
"logicRouterName" : "router1",

iMaster NCE-Fabric
"vrfName" : "Vrf1"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.13.3 Query Logical Switch Information
Typical Scenarios
Logical switch information needs to be queried.
Functions
Query logical switch information based on conditions.
Constraints
HTTP Method
POST
URI
/acdcn/v3/gbpapi/getLogicswitches
Request Parameters

er Range Value on

NCE 1-1199. switch
query
criteria,
which is
an input
paramete
r model
class.

iMaster NCE-Fabric


List has 1
to 36
charac
ters.
logicR No UUID 1 to 36 - ID of a logical "DBB702C3-77

outerId charac router. 19-4FE6-
ters. A5AD-3A9C9E2
65309"
Sample Request
HTTP
POST /acdcn/v3/gbpapi/getLogicswitches HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"logicRouterId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
Response Parameters
Table 1-1200 LogicSwitchDtoListWrapper parameters

eter t Value
logicS ARRAY For details, see Table - -

witchLi _REFER 1-1201.
st ENCE

iMaster NCE-Fabric

eter t Value

witchId characters. switch. 19-4FE6-
A5AD-3A9C9E2
65309"
logicS string - - - -
witchN
ame
vni int32 - - - -
bd int32 - - - -
subnet array< Each item has 1 - Subnet ID. -

List string> to 36
characters.
subnet array< - - - -
NameL string>
ist
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"logicSwitchList" : [
{
"subnetList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.13.4 Query Subnet Information
Typical Scenarios
Subnet information needs to be queried.
Functions
Query subnet information based on search criteria.
Constraints
HTTP Method
POST
URI
/acdcn/v3/gbpapi/getSubnets
Request Parameters

er Range Value on
input REFERE For details, see Table Subnet -

NCE 1-1203. search
criteria,
which is
an input
paramete
r model
class.

iMaster NCE-Fabric
Table 1-1203 SubnetInfoDtoWrapper parameters


List has 1
to 36
charac
ters.
subnet No array< Each - Subnet ID. -

List string> item
has 1
to 36
charac
ters.
Sample Request
HTTP
POST /acdcn/v3/gbpapi/getSubnets HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
],
"subnetList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
Response Parameters
Table 1-1204 SubnetInfoDtoListWrapper parameters

eter t Value
subnet ARRAY For details, see Table - -

List _REFER 1-1205.
ENCE

iMaster NCE-Fabric
Table 1-1205 SubnetInfoDto parameters

eter t Value

witchId characters. port. 19-4FE6-
A5AD-3A9C9E2
65309"
subnet string - - Subnet ID. "DBB702C3-77

Id 19-4FE6-
A5AD-3A9C9E2
65388"
subnet string 1 to 255 - Subnet name. "subnet1"

Name characters.
cidr string 1 to 255 - Subnet CIDR. "10.168.11.0/24

characters. "
allocat ARRAY For details, see Table - -

ion- _REFER 1-1206.
pools ENCE
Table 1-1206 L23OamAllocationPooLDto parameters

eter t Value
start string 1 to 36 - Start IP "10.168.11.22"

end string 1 to 36 - End IP address. "10.168.11.22"

characters.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"subnetList" : [
{

iMaster NCE-Fabric
"subnetName" : "subnet1",
"cidr" : "10.168.11.0/24",
"allocation-pools" : [
{
"start" : "10.168.11.22",
"end" : "10.168.11.22"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.13.5 Query Logical Port Mapping Information
Typical Scenarios
Logical port mapping information needs to be queried.
Functions
Query logical port mapping information based on conditions.
Constraints
HTTP Method
POST
URI
/acdcn/v3/gbpapi/mapping/logicport

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-1208. port
mapping
query
criteria,
which is
an input
paramete
r model
class.
Table 1-1208 LogicPortIdListWrapper parameters

logicPo No array< Each - ID of a logical -

rtIdList string> item port.
has 1
to 36
charac
ters.
Sample Request
HTTP
POST /acdcn/v3/gbpapi/mapping/logicport HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"logicPortIdList" : [
"DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
]
}
Response Parameters

iMaster NCE-Fabric
Table 1-1209 PortMappingWrapper parameters

eter t Value
portM ARRAY For details, see Table - -

apping _REFER 1-1210.
List ENCE
Table 1-1210 PortMappingDto parameters

eter t Value
logicPo UUID 1 to 36 - ID of a logical "DBB702C3-77

rtId characters. port. 19-4FE6-
A5AD-3A9C9E2
65309"
underl ARRAY For details, see Table - -

ayPort _REFER 1-1211.
List ENCE
Table 1-1211 UnderlayPortDto parameters

eter t Value
deviceI string - - Device ID. "DBB702C3-77

d 19-4FE6-
A5AD-3A9C9E2
65378"
portId UUID 1 to 36 - ID of a logical "DBB702C3-77

characters. port. 19-4FE6-
A5AD-3A9C9E2
65309"
portNa string 1 to 255 - Interface "port1"

Sample Response

iMaster NCE-Fabric
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"portMappingList" : [
{
"underlayPortList" : [
{
"portName" : "port1"
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.13.6 Query Information About All Tenants
Typical Scenarios
Information about all tenants needs to be queried.
Functions
Query information about all tenants.
Constraints
HTTP Method
GET
URI
/acdcn/v3/gbpapi/tenant
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
GET /acdcn/v3/gbpapi/tenant HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1212 TenantResultList parameters

eter t Value
tenant ARRAY For details, see Table - -

List _REFER 1-1213.
ENCE

eter t Value
id UUID 1 to 36 - Tenant ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
name string - - - -
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"tenantList" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
]
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14 VPC Communication
1.9.7.14.1 Create VPC Communication
Typical Scenarios
VPC interworking needs to be created.
Functions
Create a VPC communication instance.
Constraints
HTTP Method
POST
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/vpc-connections
Request Parameters

er Range Value on
input REFERE For details, see Table VPC -

NCE 1-1215. interworki
ng entity
to be
created.

iMaster NCE-Fabric
Table 1-1215 vpc-connections parameters

vpc- No ARRAY For details, see List of VPC ["11000000-20

connec _REFER Table 1-1216. connection 00-0000-0000-
tion ENCE objects. 000000000020
"]
Table 1-1216 vpc-connection parameters

uuid Yes string 36 - vpc-connection "11000000-200

charac ID 0-0000-0000-0
ters. 00000000020"
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
name No string 0 to - VPC connection "vpc-

255 name. connection"
charac
ters.

iMaster NCE-Fabric


d-at 128 5:30:31"
charac
ters.

d-at 128 5:30:31"
charac
ters.

name 255 name.
charac
ters.
tenant Yes string 0 to - Tenant ID. "tenant"

-id 128
charac
ters.
status No string 0 to - Status. -

128
charac
ters.
admin- No boolea - - The true

state- n administrative
up state of the
object, which is
up (true) or
down (false).

iMaster NCE-Fabric

local- Yes string 36 - Local router ID "11000000-200

router- charac representation: 0-0000-0000-0
id ters. f81d4fae-7dec- 00000000020"
The 11d0-
value a765-00a0c91e
must 6bf6
meet
the router id
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
peer- No array< - - Peer subnet list -

subnet string> representation:
s f81d4fae-7dec-
11d0-
a765-00a0c91e
6bf6 router id
descrip No string 0 to - Description of "this is a

tion 256 the IKE policy. description"
charac
ters.

iMaster NCE-Fabric

peer- Yes string 36 - Peer router ID "11000000-200

router- charac representation: 0-0000-0000-0
id ters. f81d4fae-7dec- 00000000020"
The 11d0-
value a765-00a0c91e
must 6bf6
meet
the router id
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
local- No array< - - Subnet ID set. ["11000000-20

subnet string> 00-0000-0000-
s 000000000020
"]
local- No array< - - CIDR of the ["192.168.1.1/2

cidrs string> local subnet. 4"]
Either local-
subnets or
CIDR of the
local subnet is
selected.
local- No boolea - - Whether to false

firewal n enable the
l- traffic of the
enable local router to
pass through
the firewall.

iMaster NCE-Fabric

peer- No array< - - CIDR of the ["192.168.2.1/2

cidrs string> peer subnet. 4"]
Either this
parameter or
peer-subnets is
selected.
peer- No boolea - - Whether to false

l- traffic of the
enable peer router to
pass through
the firewall.
mode No integer - - The value 0 0

indicates that
traffic is
automatically
diverted to the
video wall
based on
whether
firewall
services exist.
The value 1
indicates that
whether traffic
passes through
the firewall is
manually
specified.
priority No integer - - Route 1

preference.
Sample Request
HTTP
POST /restconf/data/huawei-ac-neutron:neutron-cfg/vpc-connections HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vpc-connection" : ["11000000-2000-0000-0000-000000000020"]
}

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.2 Query the VPC Interworking List
Typical Scenarios
VPC interworking needs to be queried.
Functions
Query all VPC interworking relationships.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/vpc-connections
Request Parameters
N/A
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/vpc-connections HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1217 vpc-connections parameters

eter t Value
vpc- ARRAY For details, see Table List of VPC ["11000000-20

connec _REFER 1-1218. connection 00-0000-0000-
tion ENCE objects. 000000000020
"]

iMaster NCE-Fabric
Table 1-1218 vpc-connection parameters

eter t Value
uuid string 36 characters. - vpc-connection "11000000-200

The value must ID 0-0000-0000-0
meet the 00000000020"
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
name string 0 to 255 - VPC connection "vpc-

characters. name. connection"



tenant string 0 to 128 - Tenant ID. "tenant"

-id characters.
status string 0 to 128 - Status. -

characters.
admin- boolea - - The true

state- n administrative
up state of the
object, which is
up (true) or
down (false).

iMaster NCE-Fabric

eter t Value
local- string 36 characters. - Local router ID "11000000-200

router- The value must representation: 0-0000-0000-0
id meet the f81d4fae-7dec- 00000000020"
following 11d0-
regular a765-00a0c91e
expression: 6bf6
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}- router id
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
peer- array< - - Peer subnet list -

subnet string> representation:
s f81d4fae-7dec-
11d0-
a765-00a0c91e
6bf6 router id
descrip string 0 to 256 - Description of "this is a

tion characters. the IKE policy. description"
peer- string 36 characters. - Peer router ID "11000000-200

router- The value must representation: 0-0000-0000-0
id meet the f81d4fae-7dec- 00000000020"
following 11d0-
regular a765-00a0c91e
expression: 6bf6
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}- router id
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
local- array< - - Subnet ID set. ["11000000-20

subnet string> 00-0000-0000-
s 000000000020
"]
local- array< - - CIDR of the ["192.168.1.1/2

cidrs string> local subnet. 4"]
Either local-
subnets or
CIDR of the
local subnet is
selected.

iMaster NCE-Fabric

eter t Value
local- boolea - - Whether to false

l- traffic of the
enable local router to
pass through
the firewall.
peer- array< - - CIDR of the ["192.168.2.1/2

cidrs string> peer subnet. 4"]
Either this
parameter or
peer-subnets is
selected.
peer- boolea - - Whether to false

l- traffic of the
enable peer router to
pass through
the firewall.
mode integer - - The value 0 0

indicates that
traffic is
automatically
diverted to the
video wall
based on
whether
firewall
services exist.
The value 1
indicates that
whether traffic
passes through
the firewall is
manually
specified.
priority integer - - Route 1

preference.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpc-connection" : ["11000000-2000-0000-0000-000000000020"]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.3 Query a VPC Interworking Connection by Name
Typical Scenarios
A VPC interworking connection needs to be queried by name.
Functions
Query VPC interworking by name.
Constraints
HTTP Method
GET
URI
/restconf/data/huawei-ac-neutron:neutron-cfg/vpc-connections/vpc-connection/
{id}

iMaster NCE-Fabric

id Yes string 1 to - VPC "11000000-200

128 interworking 0-0000-0000-0
charac ID. 00000000020"
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /restconf/data/huawei-ac-neutron:neutron-cfg/vpc-connections/vpc-connection/
11000000-2000-0000-0000-000000000020 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
vpc-connections parameters, For details, see Table 1-1217.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpc-connection" : ["11000000-2000-0000-0000-000000000020"]
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.4 Update a VPC Interworking Connection by Name
Typical Scenarios
The VPC interworking needs to be updated.
Functions
Update VPC interworking.
Constraints
HTTP Method
PUT
URI
{id}


charac ID. 00000000020"
ters.

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table VPC -

NCE 1-1215. interworki
ng entity
to be
updated.
Sample Request
HTTP
PUT /restconf/data/huawei-ac-neutron:neutron-cfg/vpc-connections/vpc-connection/
11000000-2000-0000-0000-000000000020 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vpc-connection" : ["11000000-2000-0000-0000-000000000020"]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.5 Delete a VPC Interworking Connection by Name
Typical Scenarios
VPC interworking needs to be deleted.
Functions
Delete a VPC interworking connection based on the name.
Constraints
HTTP Method
DELETE
URI
{id}


charac ID. 00000000020"
ters.
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
DELETE /restconf/data/huawei-ac-neutron:neutron-cfg/vpc-connections/vpc-connection/
11000000-2000-0000-0000-000000000020 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.6 Create a VPC Communication Instance
Typical Scenarios
A VPC connection needs to be created.

iMaster NCE-Fabric
Functions
Create a VPC connection.
Constraints
HTTP Method
POST
URI
Request Parameters


creating a VPC
communication
instance.

vpc- Yes ARRAY For details, see VPC connection -

connec _REFER Table 1-1225. instance.
t ENCE
totalN No int32 - - Total number 100

um of results.

iMaster NCE-Fabric


ID. b2d3"
name Yes string 1 to - VPC connection "vpc001"

255 name.
charac
ters.
descrip No string 0 to - VPC connection "This is vpc"

charac
ters.
localLo Yes UUID 1 to - Source VPC ID. "a915f8c1-

gicRou 255 d06f-46cd-
terId charac a968-38328e0a
ters. b2d3"
localLo No string 1 to - Source VPC "vpc002"

gicRou 255 name.
terNa charac
me ters.
localLo No UUID 0 to - Logical firewall "a915f8c1-

d charac source VPC. a968-38328e0a
ters. This parameter b2d3"
is optional. If
localFirewallEn
able is set to
true but the
logical firewall
ID is not
specified, the
controller
automatically
searches for or
allocates the
logical firewall
of the source
VPC.
localLo No string 1 to - Logical firewall "vas002"

gicVas 255 name of the
Name charac source VPC.
ters.

iMaster NCE-Fabric

localCr No ARRAY For details, see Local -

ENCE link
information.
localIn No ARRAY For details, see Local internal -

ternalL _REFER Table 1-1227. link
localCi No array< - - Source network -

The value is a
string.
peerLo Yes UUID 1 to - ID of the "a915f8c1-

gicRou 255 destination d06f-46cd-
terId charac VPC. a968-38328e0a
ters. b2d3"
peerLo No string 1 to - Name of the "router002"

gicRou 255 destination
terNa charac VPC.
me ters.
peerLo No UUID 1 to - Logical firewall "a915f8c1-

d charac destination a968-38328e0a
ters. VPC. This b2d3"
parameter is
optional. If
peerFirewallEn
able is set to
true but the
logical firewall
ID is not
specified, the
controller
automatically
searches for or
allocates the
logical firewall
of the
destination
VPC.
peerLo No string 1 to - Name of the "vas003"

gicVas 255 logical firewall
Name charac for the
ters. destination
VPC.

iMaster NCE-Fabric

peerCr No ARRAY For details, see Peer -

ENCE link
information.
peerInt No ARRAY For details, see Peer internal -

ernalLi _REFER Table 1-1227. link
peerCi No array< - - List of -

network
segments. The
value is a
string.
tenantI No UUID 0 to - Tenant ID. "DBB702C3-77

d 255 19-4FE6-
charac A5AD-3A9C9E2
ters. 6530"
tenant No string 1 to - Name of the "tenant1"

Name 255 tenant to
charac which the local
peerTe No UUID 0 to - Tenant to "a915f8c1-

nantId 255 which the peer d06f-46cd-
charac router belongs. a968-38328e0a
ters. b2d3"
peerTe No string 1 to - Name of the "tenant1"

nantN 255 tenant to
ame charac which the peer

localFir No boolea - false Whether the false

source VPC. It
is disabled by
default.

iMaster NCE-Fabric

peerFir No boolea - false Whether the true

nable VPC is
protected by a
firewall. By
default, this
function is
disabled.
isLocal No boolea - false Whether to false

All n enable
dynamic
routing on the
local end in the
MDC scenario.
isPeer No boolea - false Whether to true

All n enable
dynamic
routing on the
peer end in the
MDC scenario.
priority No int32 - - Priority of a 60

static route.
localPr No int32 - - Local 50

e BGP routes in a
routing policy.
dciGat No array< 0-2147 - DCI gateway -

ewayId string> 48364 device group
s 7 ID.
items.
connec No string 0 to - Route target "1:3,65537:3,0.

tRt 255 for VPC 0:3,192.168.122
charac communication .15:1."
ters. .
srcGw No array< 0-2147 - ID list of source -

DeviceI string> 48364 egress
ds 7 gateways for
items. VPC
communication
.

iMaster NCE-Fabric

dstGw No array< 0-2147 - ID list of -

DeviceI string> 48364 destination
ds 7 egress
items. gateways for
VPC
communication
.
localR No string 1 to - Type of the "LogicRouter/

outerT 255 local router. ExternalTransit
ype charac Router/
ters. ExternalGatew
ay"
peerRo No string 1 to - Type of the "LogicRouter/

uterTy 255 peer router. ExternalTransit
pe charac Router/
ters. ExternalGatew
ay"
isAssoc No boolea - true Whether to true

pcCon interworking
nPolicy policy.


charac router.
ters.

255 IP address on
charac the logical VAS
ters. device.
vlan No string 0 to 64 - Interconnection "100"

charac VLAN.
ters.

ters. router.

iMaster NCE-Fabric


ters. VAS device.
fabricI No string 0 to 36 - Unique ID of a "DBB702C3-77

d charac fabric. 19-4FE6-4488-
ters. 3A9C9E265322
"

routerI No string 0 to - IP address of "10.1.1.1"

p 255 the router.
charac
ters.
vasIp No string 0 to - IP address of "10.1.1.1"

255 the logical VAS
charac device.
ters.
vlan No string 0 to 64 - VLAN. "100"

charac
ters.
routerI No string 0 to - IPv6 address of "FE80:0000:000

pv6 255 the router. 0:0000:0000:00
charac 44:0000:0032"
ters.

6 255 the logical VAS 0:0000:0000:00
charac device. 44:0000:0032"
ters.


ters. condition.

iMaster NCE-Fabric


At 255 0:11:16.000+00:
charac 00"
ters.

At 255 0:11:16.000+00:
charac 00"
ters.
Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/vpc-connects HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",

iMaster NCE-Fabric
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
}
],
"totalNum" : 100
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.7 Query VPC Connections
Typical Scenarios
Use this API to query the VPC communication instance list.
Functions
This API is used to query the VPC communication instance list based on the
producer or the tenant ID.
Constraints
HTTP Method
GET
URI


ters. condition.
isTrans No boolea - false Whether to -

it n query all
transit VPC
connections.

iMaster NCE-Fabric

tenantI No UUID - - ID of the "a915f8c1-

d tenant to d06f-46cd-
which the SFC a968-38328e0a
template b2d3"
belongs.

dex

ze
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vpc-connects?producer=CloudPlatform1&tenantId=a915f8c1-
d06f-46cd-a968-38328e0ab2d3&pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

eter t Value
vpc- ARRAY For details, see Table VPC connection -

connec _REFER 1-1231. instance.
t ENCE

um of results.

iMaster NCE-Fabric

eter t Value
id UUID - - VPC "a915f8c1-

ID. b2d3"
name string 1 to 255 - VPC connection "vpc001"

characters. name.
descrip string 0 to 255 - VPC connection "This is vpc"

localLo UUID 1 to 255 - Source VPC ID. "a915f8c1-

gicRou characters. d06f-46cd-
terId a968-38328e0a
b2d3"
localLo string 1 to 255 - Source VPC "vpc002"

gicRou characters. name.
terNa
me
localLo UUID 0 to 255 - Logical firewall "a915f8c1-

d source VPC. a968-38328e0a
This parameter b2d3"
is optional. If
localFirewallEn
able is set to
true but the
logical firewall
ID is not
specified, the
controller
automatically
searches for or
allocates the
logical firewall
of the source
VPC.
localLo string 1 to 255 - Logical firewall "vas002"

gicVas characters. name of the
Name source VPC.
localCr ARRAY For details, see Table Local -

ENCE link
information.

iMaster NCE-Fabric

eter t Value
localIn ARRAY For details, see Table Local internal -

ternalL _REFER 1-1233. link
localCi array< - - Source network -

The value is a
string.
peerLo UUID 1 to 255 - ID of the "a915f8c1-

gicRou characters. destination d06f-46cd-
terId VPC. a968-38328e0a
b2d3"
peerLo string 1 to 255 - Name of the "router002"

gicRou characters. destination
terNa VPC.
me
peerLo UUID 1 to 250 - Logical firewall "a915f8c1-

d destination a968-38328e0a
VPC. This b2d3"
parameter is
optional. If
peerFirewallEn
able is set to
true but the
logical firewall
ID is not
specified, the
controller
automatically
searches for or
allocates the
logical firewall
of the
destination
VPC.
peerLo string 1 to 255 - Name of the "vas003"

gicVas characters. logical firewall
Name for the
destination
VPC.
peerCr ARRAY For details, see Table Peer -

ENCE link
information.

iMaster NCE-Fabric

eter t Value
peerInt ARRAY For details, see Table Peer internal -

ernalLi _REFER 1-1233. link
peerCi array< - - List of -

network
segments. The
value is a
string.
tenantI UUID 0 to 255 - Tenant ID. "DBB702C3-77

A5AD-3A9C9E2
6530"
tenant string 1 to 255 - Name of the "tenant1"

Name characters. tenant to
which the local
router belongs.
peerTe UUID 0 to 255 - Tenant to "a915f8c1-

nantId characters. which the peer d06f-46cd-
router belongs. a968-38328e0a
b2d3"
peerTe string 1 to 255 - Name of the "tenant1"

nantN characters. tenant to
ame which the peer
router belongs.

nal ENCE 1-1234.
localFir boolea - false Whether the false

source VPC. It
is disabled by
default.
peerFir boolea - false Whether the true

nable VPC is
protected by a
firewall. By
default, this
function is
disabled.

iMaster NCE-Fabric

eter t Value
isLocal boolea - false Whether to false

All n enable
dynamic
routing on the
local end in the
MDC scenario.
isPeer boolea - false Whether to true

All n enable
dynamic
routing on the
peer end in the
MDC scenario.
priority int32 - - Priority of a 60

static route.
localPr int32 - - Local 50

e BGP routes in a
routing policy.
dciGat array< 0-2147483647 - DCI gateway -

ewayId string> items. device group
s ID.
connec string 0 to 255 - Route target "1:3,65537:3,0.

tRt characters. for VPC 0:3,192.168.122
communication .15:1."
.
srcGw array< 0-2147483647 - ID list of source -

DeviceI string> items. egress
ds gateways for
VPC
communication
.
dstGw array< 0-2147483647 - ID list of -

DeviceI string> items. destination
ds egress
gateways for
VPC
communication
.

iMaster NCE-Fabric

eter t Value
localR string 1 to 255 - Type of the "LogicRouter/

outerT characters. local router. ExternalTransit
ype Router/
ExternalGatew
ay"
peerRo string 1 to 255 - Type of the "LogicRouter/

uterTy characters. peer router. ExternalTransit
pe Router/
ExternalGatew
ay"
isAssoc boolea - true Whether to true

pcCon interworking
nPolicy policy.

eter t Value

router.

characters. IP address on
the logical VAS
device.

characters. VLAN.

address on a 44:0000:0032"
router.

address on a 44:0000:0032"
VAS device.
fabricI string 0 to 36 - Unique ID of a "DBB702C3-77

d characters. fabric. 19-4FE6-4488-
3A9C9E265322
"

iMaster NCE-Fabric

eter t Value
routerI string 0 to 255 - IP address of "10.1.1.1"

p characters. the router.
vasIp string 0 to 255 - IP address of "10.1.1.1"

characters. the logical VAS
device.
vlan string 0 to 64 - VLAN. "100"

characters.
routerI string 0 to 255 - IPv6 address of "FE80:0000:000

pv6 characters. the router. 0:0000:0000:00
44:0000:0032"

6 characters. the logical VAS 0:0000:0000:00
device. 44:0000:0032"

eter t Value

condition.

00"

00"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"

iMaster NCE-Fabric
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
}
],
"totalNum" : 100
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.8 Query a VPC Communication Instance
Typical Scenarios
Use this API to query a VPC communication instance.
Functions
Query a VPC connection by ID.
Constraints
HTTP Method
GET
URI

iMaster NCE-Fabric


ID. b2d3"
Request Parameters

dtId No string 0 to - distribution "G2021110115

256 transaction ID. 2812691_b34d
charac 98a-57f9-49b2
ters. -910c-010bcfcc
97bcd"
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/vpc-connects/vpc-connect/a915f8c1-d06f-46cd-a968-38328e0ab2d3
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
dtId: "G20211101152812691_b34d98a-57f9-49b2-910c-010bcfcc97bcd"
Response Parameters

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],

iMaster NCE-Fabric
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
}
],
"totalNum" : 100
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.9 Update a VPC Communication Instance
Typical Scenarios
A VPC connection needs to be updated by ID.
Functions
Update a VPC connection by ID.
Constraints
HTTP Method
PUT

iMaster NCE-Fabric
URI


ID. b2d3"
Request Parameters


creating a VPC
communication
instance.
Sample Request
HTTP
PUT /controller/dc/v3/servicenetwork/vpc-connects/vpc-connect/a915f8c1-d06f-46cd-a968-38328e0ab2d3
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",

iMaster NCE-Fabric
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],

iMaster NCE-Fabric
}
],
"totalNum" : 100
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"vpc-connect" : [
{
"id" : "a915f8c1-d06f-46cd-a968-38328e0ab2d3",
"name" : "vpc001",
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"localCidrs" : [
"10.1.1.1/24"
],
"peerCrossLink" : [
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",

iMaster NCE-Fabric
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
}
],
{
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.1",
"vlan" : "100",
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032"
}
],
"peerCidrs" : [
"10.1.1.1/24"
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
},
"isPeerAll" : true,
"priority" : 60,
"dciGatewayIds" : [
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"connectRt" : "1:3,65537:3,0.0:3,192.168.122.15:1.",
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
"a915f8c1-d06f-46cd-a968-38328e0ab2d3"
],
}
],
"totalNum" : 100
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.14.10 Delete a VPC Communication Instance
Typical Scenarios
A VPC connection needs to be deleted by ID.

iMaster NCE-Fabric
Functions
Delete a VPC connection by ID.
Constraints
HTTP Method
DELETE
URI


ID. b2d3"


er Controller-
MDC"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/servicenetwork/vpc-connects/vpc-connect/a915f8c1-d06f-46cd-
a968-38328e0ab2d3?producer=Agile-Controller-MDC HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.15 Application Example of the VPC Communication Policy

# VPC communication policy application instance interface description:
1. VPC communication policy application instance service.
1.9.7.15.1 Create a VPC Communication Policy Application Instance
Typical Scenarios
A VPC communication policy application instance needs to be created.
Functions
Create a VPC communication policy application instance based on conditions.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/controller/dc/v3/sfco/vpcConnectPolicy
Request Parameters

dtId No string 0 to - Transaction ID. "G2021100817

256 3530511_dbadc
charac 40-ece4-421c-
ters. bef8-
b6548c12d4c7d
"

scapp Yes REFER For details, see Input -

ENCE Table 1-1243. parameter for
creating a VPC
communication
policy
application
instance.
Table 1-1243 ScappDtoWrapper parameters

scapp Yes ARRAY For details, see SFC instance -

ENCE

iMaster NCE-Fabric
Table 1-1244 ScappDto parameters

id Yes UUID - - SFC application "CCB702C3-77

instance ID. 19-4FE6-
A5AD-3A9C9E2
65309"
name Yes string 1 to - SFC application "logicfw1"

255 instance name.
charac
ters.
descrip No string 0 to - SFC application "This is scapp"

tion 255 instance
charac description.
ters.
tenantI No UUID - - Tenant to "CCB702C3-77

d which an SFC 19-4FE6-
application A5AD-3A9C9E2
instance 65309"
belongs.
dstTen No UUID 36 - Destination "CCB702C3-77

antId charac tenant to 19-4FE6-
ters. which the A5AD-3A9C9E2
The service chain 65309"
value application
must instance
meet belongs. This
the field is read-
followi only.
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

srcApp No string 36 - Source app ID. "CCB702C3-77

Id charac This field is 19-4FE6-
ters. read-only. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric

dstApp No string 36 - Destination "CCB702C3-77

Id charac app ID. This 19-4FE6-
ters. field is read- A5AD-3A9C9E2
The only. 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
logicN No UUID - - Logical "CCB702C3-77

etwork network where 19-4FE6-
Id an SFC A5AD-3A9C9E2
application 65309"
instance is
located.
srcEpgI Yes UUID - - Source EPG. "CCB702C3-77

d 19-4FE6-
A5AD-3A9C9E2
65309"
dstEpg Yes UUID - - Destination "CCB702C3-77

Id EPG. 19-4FE6-
A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

filterAc Yes string ● FILT - Traffic policy. "FILTER"

tion ER The options are
● RED as follows:
IRE FILTER (SFC
CT policy applied)
REDIRECT
● FOR FORWARD
WA DENY
RD
● DE
NY
filterDi No string ● In Bothdir Policy delivery "Bothdirectiona

rection ectiona direction. The l"
● Out l options are as
● Bot follows: In:
hdir inbound
ecti direction Out:
ona outbound
l direction
Bothdirectional
: bidirectional.
This field is
required when
filterAction is
set to
REDIRECT,
FORWARD, or
DENY. In this
case, no policy
is selected for
the service
chain, and the
policy delivery
direction is
identified. The
default value is
Bothdirectional
.

iMaster NCE-Fabric

contra No string 36 - SFC ID. "CCB702C3-77

ctId charac 19-4FE6-
ters. A5AD-3A9C9E2
The 65309"
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
rules No ARRAY 0-512 items. For Policy that is -

_REFER details, see created for the
ENCE Table 1-1245. service chain.
This parameter
is mandatory
when
filterAction is
set to FILTER.
Either this
parameter or
contractId
must be set.
contractId is
used
preferentially.
sfp Yes REFER For details, see - -

ENCE Table 1-1248.


iMaster NCE-Fabric
Table 1-1245 ContractRuleDto parameters

id No string 0 to - Rule ID. "DBB702C3-77

255 19-4FE6-
charac A5AD-3A9C9E2
ters. 65300"
36
charac
ters.
The
value
must
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
behavi Yes string 4 to 10 - Rule behavior, "DENY"

or charac which can be
ters. DENY,
FORWARD, or
REDIRECT.
order Yes int32 [0-655 - Rule order. 1

35]
classifi Yes REFER For details, see information -

er ENCE Table 1-1246. about service
chain policy.

iMaster NCE-Fabric
Table 1-1246 ClassifierDto parameters

ipFami Yes string 0 to - IP address "IPv4 or IPv6."

ly 255 family. The
charac value can be
ters. IPv4 or IPv6.
sourceI No string 0 to - Source IP "1.1.1.0/24 or

p 255 address FE80::/10,
charac which must be
ters. the same as
the address
family
configuration."
destina No string 0 to - Destination IP "1.1.1.0/24 or

tionIp 255 address FE80::/10,
charac which must be
ters. the same as
the address
family
configuration."
protoc Yes int32 [0-255 - The value is an 17

ol ] integer that
ranges from 0
to 255. The
value
expressed by
name can be
gre (47), icmp
(1), igmp (2),
ip (0), ipinip
(4), ospf (89),
tcp (6), udp
(17), or icmpv6
(58).
source No string 0 to - Source port "startPort :

PortRa 255 expressed in 3000"
nge charac the format of n
ters. or x:y, such as
4 or 6:8. The
value range is
from 0 to
65535 for n, x,
and y.

iMaster NCE-Fabric

destPo No string 0 to - Destination "startPort :

rtRang 255 port expressed 3000"
e charac in the format
ters. of n or x:y,
such as 4 or
6:8. The value
range is from 0
to 65535 for n,
x, and y.
directi No string ● In - Direction. "Bothdirectiona

on l"
● Out
● Bot
hdir
ecti
ona
l
loggin No boolea - - Log. true

g n
tcpFla No ARRAY 0-6 items. For TCP flag list. -

g _REFER details, see
ENCE Table 1-1247.

iMaster NCE-Fabric

icmpTy No string ● Add - ICMP flag. "Echo"

pe ress
Mas
kRe
ply
● Add
ress
Mas
kRe
que
st
● Ech
o
● Ech
oRe
ply
● Fra
gm
ent
nee
dDf
set
● Hos
tRe
dire
ct
● Hos
tTos
Red
irect
● Hos
tUn
reac
hab
le
● Info
rma
tion
Rep
ly
● Info
rma
tion
Req
uest

iMaster NCE-Fabric

● Net
Red
irect
● Net
Tos
Red
irect
● Net
Unr
eac
hab
le
● Par
am
eter
Pro
ble
m
● Port
Unr
eac
hab
le
● Prot
ocol
Unr
eac
hab
le
● Rea
sse
mbl
yTi
me
out
● Sou
rce
Que
nch
● Sou
rceR
out
eFai
led
● Tim
esta

iMaster NCE-Fabric

mp
Rep
ly
● Tim
esta
mp
Req
uest
● TtlE
xce
ede
d

iMaster NCE-Fabric

icmp6 No string ● Red - ICMPv6 flag. "Echo"

Type irect
● Ech
o
● Ech
oRe
ply
● Err
Hea
der
Fiel
d
● Fra
gTi
me
Exc
eed
ed
● Hop
Limi
tExc
eed
ed
● Hos
tAd
min
Pro
hib
● Hos
tUn
reac
hab
le
● Nei
ghb
orA
dve
rtise
me
nt
● Nei
ghb
orS
olici
tati
on

iMaster NCE-Fabric

● Net
wor
kUn
reac
hab
le
● Pac
ket
Too
Big
● Port
Unr
eac
hab
le
● Rou
terA
dve
rtise
me
nt
● Rou
terS
olici
tati
on
● Unk
now
nIpv
6Op
t
● Unk
now
nNe
xtH
dr

iMaster NCE-Fabric
Table 1-1247 TcpFlagEnum parameters

TcpFla Yes string ● Esta - TCP flag. "Established"

gEnum blis
hed
● Urg
● Ack
● Psh
● Rst
● Syn
● Fin
Table 1-1248 SfpDto parameters

sfcId Yes UUID - - SFC (template) "CBB702C3-77

ID. 19-4FE6-
A5AD-3A9C9E2
653091"
sfPath No ARRAY For details, see SFC path ID. -

Hop _REFER Table 1-1249.
ENCE
Table 1-1249 SfPathHop parameters

hopNu Yes int32 [1-255 - Node number 1

mber ] on an SFC
path.
logicSF Yes UUID - - SF ID. "CBB702C3-77

Id 19-4FE6-
A5AD-3A9C9E2
653091"
sfType Yes string 1 to - SF type. "NAT"

255
charac
ters.

iMaster NCE-Fabric


ters. condition.

At 255 0:11:16.000+00:
charac 00"
ters.

At 255 0:11:16.000+00:
charac 00"
ters.
Sample Request
HTTP
POST /controller/dc/v3/sfco/vpcConnectPolicy HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
dtId: "G20211008173530511_dbadc40-ece4-421c-bef8-b6548c12d4c7d"
{
"scapp" : [
{
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"description" : "This is scapp",
"tenantId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"dstTenantId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"srcAppId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"dstAppId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"logicNetworkId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"srcEpgId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"dstEpgId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"filterAction" : "FILTER",
"filterDirection" : "Bothdirectional",
"contractId" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"rules" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265300",
"behavior" : "DENY",
"order" : 1,
"classifier" : {
"ipFamily" : "IPv4 or IPv6.",
"sourceIp" : "1.1.1.0/24 or FE80::/10, which must be the same as the address family
configuration.",
"destinationIp" : "1.1.1.0/24 or FE80::/10, which must be the same as the address family
configuration.",
"protocol" : 17,
"sourcePortRange" : "startPort : 3000",
"destPortRange" : "startPort : 3000",
"direction" : "Bothdirectional",

iMaster NCE-Fabric
"logging" : true,
"tcpFlag" : [
"Established"
],
"icmpType" : "Echo",
"icmp6Type" : "Echo"
}
}
],
"sfp" : {
"sfcId" : "CBB702C3-7719-4FE6-A5AD-3A9C9E2653091",
"sfPathHop" : [
{
"hopNumber" : 1,
"logicSFId" : "CBB702C3-7719-4FE6-A5AD-3A9C9E2653091",
"sfType" : "NAT"
}
]
},
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Response Parameters
Table 1-1251 ScappDtoWrapper parameters

eter t Value
scapp ARRAY For details, see Table SFC instance -

ENCE
Table 1-1252 ScappDto parameters

eter t Value
id UUID - - SFC application "CCB702C3-77

instance ID. 19-4FE6-
A5AD-3A9C9E2
65309"
name string 1 to 255 - SFC application "logicfw1"

characters. instance name.
descrip string 0 to 255 - SFC application "This is scapp"

tion characters. instance
description.

iMaster NCE-Fabric

eter t Value
tenantI UUID - - Tenant to "CCB702C3-77

d which an SFC 19-4FE6-
application A5AD-3A9C9E2
instance 65309"
belongs.
dstTen UUID 36 characters. - Destination "CCB702C3-77

antId The value must tenant to 19-4FE6-
meet the which the A5AD-3A9C9E2
following service chain 65309"
regular application
expression: instance
[0-9a-fA-F]{8}- belongs. This
[0-9a-fA-F]{4}- field is read-
[0-9a-fA-F]{4}- only.
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
srcApp string 36 characters. - Source app ID. "CCB702C3-77

Id The value must This field is 19-4FE6-
meet the read-only. A5AD-3A9C9E2
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
dstApp string 36 characters. - Destination "CCB702C3-77

Id The value must app ID. This 19-4FE6-
meet the field is read- A5AD-3A9C9E2
following only. 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
logicN UUID - - Logical "CCB702C3-77

etwork network where 19-4FE6-
Id an SFC A5AD-3A9C9E2
application 65309"
instance is
located.
srcEpgI UUID - - Source EPG. "CCB702C3-77

d 19-4FE6-
A5AD-3A9C9E2
65309"
dstEpg UUID - - Destination "CCB702C3-77

Id EPG. 19-4FE6-
A5AD-3A9C9E2
65309"
filterAc string ● FILTER - Traffic policy. "FILTER"

tion The options are
● REDIRECT
as follows:
● FORWARD FILTER (SFC
● DENY policy applied)
REDIRECT
FORWARD
DENY

iMaster NCE-Fabric

eter t Value
filterDi string ● In Bothdir Policy delivery "Bothdirectiona

rection ectiona direction. The l"
● Out l options are as
● Bothdirectio follows: In:
nal inbound
direction Out:
outbound
direction
Bothdirectional
: bidirectional.
This field is
required when
filterAction is
set to
REDIRECT,
FORWARD, or
DENY. In this
case, no policy
is selected for
the service
chain, and the
policy delivery
direction is
identified. The
default value is
Bothdirectional
.
contra string 36 characters. - SFC ID. "CCB702C3-77

ctId The value must 19-4FE6-
following 65309"
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.

iMaster NCE-Fabric

eter t Value
rules ARRAY 0-512 items. For details, Policy that is -

_REFER see Table 1-1253. created for the
ENCE service chain.
This parameter
is mandatory
when
filterAction is
set to FILTER.
Either this
parameter or
contractId
must be set.
contractId is
used
preferentially.
sfp REFER For details, see Table - -

ENCE 1-1256.

nal ENCE 1-1258.
Table 1-1253 ContractRuleDto parameters

eter t Value
id string 0 to 255 - Rule ID. "DBB702C3-77

value must 65300"
meet the
following
regular
expression:
[0-9a-fA-F]{8}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]{4}-
[0-9a-fA-F]
{12}.
behavi string 4 to 10 - Rule behavior, "DENY"

or characters. which can be
DENY,
FORWARD, or
REDIRECT.

iMaster NCE-Fabric

eter t Value
order int32 [0-65535] - Rule order. 1
classifi REFER For details, see Table information -

er ENCE 1-1254. about service
chain policy.
Table 1-1254 ClassifierDto parameters

eter t Value
ipFami string 0 to 255 - IP address "IPv4 or IPv6."

ly characters. family. The
value can be
IPv4 or IPv6.
sourceI string 0 to 255 - Source IP "1.1.1.0/24 or

p characters. address FE80::/10,
which must be
the same as
the address
family
configuration."
destina string 0 to 255 - Destination IP "1.1.1.0/24 or

tionIp characters. address FE80::/10,
which must be
the same as
the address
family
configuration."
protoc int32 [0-255] - The value is an 17

ol integer that
ranges from 0
to 255. The
value
expressed by
name can be
gre (47), icmp
(1), igmp (2),
ip (0), ipinip
(4), ospf (89),
tcp (6), udp
(17), or icmpv6
(58).

iMaster NCE-Fabric

eter t Value
source string 0 to 255 - Source port "startPort :

PortRa characters. expressed in 3000"
nge the format of n
or x:y, such as
4 or 6:8. The
value range is
from 0 to
65535 for n, x,
and y.
destPo string 0 to 255 - Destination "startPort :

rtRang characters. port expressed 3000"
e in the format
of n or x:y,
such as 4 or
6:8. The value
range is from 0
to 65535 for n,
x, and y.
directi string ● In - Direction. "Bothdirectiona

on l"
● Out
● Bothdirectio
nal
loggin boolea - - Log. true

g n
tcpFla ARRAY 0-6 items. For details, see TCP flag list. -
g _REFER Table 1-1255.
ENCE

iMaster NCE-Fabric

eter t Value
icmpTy string ● AddressMas - ICMP flag. "Echo"

pe kReply
● AddressMas
kRequest
● Echo
● EchoReply
● Fragmentne
edDfset
● HostRedirect
● HostTosRedir
ect
● HostUnreach
able
● Information
Reply
● Information
Request
● NetRedirect
● NetTosRedir
ect
● NetUnreach
able
● ParameterPr
oblem
● PortUnreach
able
● ProtocolUnre
achable
● ReassemblyT
imeout
● SourceQuen
ch
● SourceRoute
Failed
● TimestampR
eply
● TimestampR
equest
● TtlExceeded

iMaster NCE-Fabric

eter t Value
icmp6 string ● Redirect - ICMPv6 flag. "Echo"

Type
● Echo
● EchoReply
● ErrHeaderFie
ld
● FragTimeExc
eeded
● HopLimitExc
eeded
● HostAdminP
rohib
● HostUnreach
able
● NeighborAd
vertisement
● NeighborSoli
citation
● NetworkUnr
eachable
● PacketTooBi
g
● PortUnreach
able
● RouterAdver
tisement
● RouterSolicit
ation
● UnknownIpv
6Opt
● UnknownNe
xtHdr

iMaster NCE-Fabric
Table 1-1255 TcpFlagEnum parameters

eter t Value
TcpFla string ● Established - TCP flag. "Established"

gEnum
● Urg
● Ack
● Psh
● Rst
● Syn
● Fin
Table 1-1256 SfpDto parameters

eter t Value
sfcId UUID - - SFC (template) "CBB702C3-77

ID. 19-4FE6-
A5AD-3A9C9E2
653091"
sfPath ARRAY For details, see Table SFC path ID. -

Hop _REFER 1-1257.
ENCE
Table 1-1257 SfPathHop parameters

eter t Value
hopNu int32 [1-255] - Node number 1

mber on an SFC
path.
logicSF UUID - - SF ID. "CBB702C3-77

Id 19-4FE6-
A5AD-3A9C9E2
653091"
sfType string 1 to 255 - SF type. "NAT"

characters.

iMaster NCE-Fabric

eter t Value

condition.

00"

00"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"scapp" : [
{
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"rules" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265300",
"order" : 1,
"classifier" : {
configuration.",
configuration.",
"protocol" : 17,

iMaster NCE-Fabric
"logging" : true,
"tcpFlag" : [
"Established"
],
}
}
],
"sfp" : {
"sfPathHop" : [
{
"hopNumber" : 1,
"sfType" : "NAT"
}
]
},
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.15.2 Query the VPC Communication Policy Application Instance List
Typical Scenarios
A VPC communication policy application instance list needs to be queried.
Functions
Query the list of VPC communication policy application instances based on
producer and tenant ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/sfco/vpcConnectPolicy

iMaster NCE-Fabric

produc No string 0 to 36 - Source of the "CloudPlatform

er charac VPC 1"
ters. communication
policy.
tenantI No string 36 - Tenant to "00215123-100

d charac which the VPC 0-0000-0001-0
ters. communication 00000000001"
The policy
value application
must instance
meet belongs.
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

dex 255 number.
charac
ters.
pageSi No string 0 to - Number of "10"

ze 255 results on each
charac page.
ters.
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v3/sfco/vpcConnectPolicy?
producer=CloudPlatform1&tenantId=00215123-1000-0000-0001-000000000001&pageIndex=1&pageSize=10
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Response status code 200: successfully.
Table 1-1260 ScappListDtoWrapper parameters

eter t Value
scapp ARRAY For details, see Table SFC instance -

ENCE

um of results.

dex

ze
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"scapp" : [
{
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"rules" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265300",
"order" : 1,
"classifier" : {
configuration.",
configuration.",
"protocol" : 17,
"logging" : true,
"tcpFlag" : [
"Established"
],
}
}
],
"sfp" : {
"sfPathHop" : [
{
"hopNumber" : 1,
"sfType" : "NAT"
}
]
},
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
],
"totalNum" : 100,
"pageIndex" : 1,
"pageSize" : 4000
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.15.3 Query a VPC Communication Policy Application Instance
Typical Scenarios
A VPC communication policy application instance needs to be queried.

iMaster NCE-Fabric
Functions
Query the VPC communication policy application instance based on the ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/sfco/vpcConnectPolicy/{id}

id Yes string 36 - ID of the "00215123-100

charac instance to 0-0000-0001-0
ters. which the VPC 00000000001"
The communication
value policy is
must applied.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/sfco/vpcConnectPolicy/00215123-1000-0000-0001-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
ScappDtoWrapper parameters, For details, see Table 1-1251.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"scapp" : [
{
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"rules" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265300",
"order" : 1,
"classifier" : {
configuration.",
configuration.",
"protocol" : 17,

iMaster NCE-Fabric

"logging" : true,
"tcpFlag" : [
"Established"
],
}
}
],
"sfp" : {
"sfPathHop" : [
{
"hopNumber" : 1,
"sfType" : "NAT"
}
]
},
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.15.4 Update a VPC Communication Policy Application Instance
Typical Scenarios
A VPC communication policy application instance needs to be updated.
Functions
Update the VPC communication policy application instance based on the ID.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric


The communication
value policy is
must applied.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters


256 3530511_dbadc
ters. bef8-
b6548c12d4c7d
"

iMaster NCE-Fabric

scapp Yes REFER For details, see Input and -

ENCE Table 1-1243. output
parameters of
the API for
updating a VPC
communication
policy instance.
Sample Request
HTTP
PUT /controller/dc/v3/sfco/vpcConnectPolicy/00215123-1000-0000-0001-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"scapp" : [
{
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"rules" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265300",
"order" : 1,
"classifier" : {
configuration.",
configuration.",
"protocol" : 17,
"logging" : true,
"tcpFlag" : [
"Established"
],
}

iMaster NCE-Fabric
}
],
"sfp" : {
"sfPathHop" : [
{
"hopNumber" : 1,
"sfType" : "NAT"
}
]
},
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Response Parameters
ScappDtoWrapper parameters, For details, see Table 1-1251.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"scapp" : [
{
"id" : "CCB702C3-7719-4FE6-A5AD-3A9C9E265309",
"rules" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265300",
"order" : 1,
"classifier" : {
configuration.",

iMaster NCE-Fabric
configuration.",
"protocol" : 17,
"logging" : true,
"tcpFlag" : [
"Established"
],
}
}
],
"sfp" : {
"sfPathHop" : [
{
"hopNumber" : 1,
"sfType" : "NAT"
}
]
},
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.15.5 Delete a VPC Communication Policy Application Instance
Typical Scenarios
A VPC communication policy application instance needs to be deleted.
Functions
Delete a VPC communication policy application instance based on the ID.
Constraints
HTTP Method
DELETE
URI

iMaster NCE-Fabric


The communication
value policy is
must applied.
meet
the
followi
ng
regular
expres
sion:
[0-9a-
fA-F]
{8}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{4}-
[0-9a-
fA-F]
{12}.
Request Parameters


256 3530511_dbadc
ters. bef8-
b6548c12d4c7d
"
N/A

iMaster NCE-Fabric
Sample Request
HTTP
DELETE /controller/dc/v3/sfco/vpcConnectPolicy/00215123-1000-0000-0001-000000000001 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.16 External Network Management

External network API description: 1. Query an external network.
Typical Scenarios
All logical networks need to be queried.
Functions
Query all logical networks.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/external-networks


ze

dex
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/external-networks?pageSize=10&pageIndex=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1268 ExternalNetworkDtoPagedWrapper parameters

eter t Value
extern ARRAY For details, see Table "" -

alnetw _REFER 1-1269.
ork ENCE
pageSi int32 - 4000 "" 4000

ze
pageIn int32 - 1 "" 1

dex

iMaster NCE-Fabric

eter t Value
totalN int32 - - "" 5

um
Table 1-1269 ExNetDto parameters

eter t Value
id string 36 characters. - External "DBB702C3-77

network ID. 19-4FE6-
cannot be 65309"
updated.
name string 1 to 255 - Name. "name"

characters.
networ int32 - - Network type. 0

kType The options are
as follows:
0:Public and
1:Private.
publicI array< - - Associated ["10.1.1.0/24"]

pPool string> CIDR network.
extern string 36 characters. - Associated "DBB702C3-77

alGate external 19-4FE6-
wayId gateway ID. A5AD-3A9C9E2
This field 65309"
cannot be
updated.
tenantI string 36 characters. - Tenant to "DBB702C3-77

d which a logical 19-4FE6-
network A5AD-3A9C9E2
parameter is
left empty, it is
a public VPC.
This field
cannot be
updated.
public string 36 characters. - Public router "DBB702C3-77

Router ID. 19-4FE6-
Id A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
logicN string 36 characters. - Logical "DBB702C3-77

etwork network ID. 19-4FE6-
Id A5AD-3A9C9E2
65309"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"externalnetwork" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"networkType" : 0,
"publicIpPool" : ["10.1.1.0/24"],
"publicRouterId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"logicNetworkId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
],
"pageSize" : 4000,
"pageIndex" : 1,
"totalNum" : 5
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.16.2 Query an External Network by ID
Typical Scenarios
An external network needs to be queried by ID.
Functions
Query an external network by ID.

iMaster NCE-Fabric
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/external-networks/external-network/{id}

id Yes string 36 - External "DBB702C3-77

charac network ID. 19-4FE6-
ters. This field A5AD-3A9C9E2
cannot be 65309"
updated.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/external-networks/external-network/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1271 ExternalNetworkRestfulDtoWrapper parameters

eter t Value
extern ARRAY For details, see Table "" -

alnetw _REFER 1-1269.
ork ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"externalnetwork" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "name",
"networkType" : 0,
"publicIpPool" : ["10.1.1.0/24"],
"publicRouterId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"logicNetworkId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.17 External Network Connection

# Description of external network connection interfaces:
1. Create an external network connection.
1.9.7.17.1 Create an External Network Connection
Typical Scenarios
An external network connection needs to be created.

iMaster NCE-Fabric
Functions
Create an external network connection based on the request information.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/servicenetwork/external-connects
Request Parameters

er Range Value on

NCE 1-1273. s for
creating
an
external
network
connectio
n.
Table 1-1273 ExternalConnectRestfulDtoWrapper parameters

extern Yes ARRAY For details, see - -

al- _REFER Table 1-1274.
connec ENCE
t

iMaster NCE-Fabric
Table 1-1274 ExternalConnectDto parameters

id Yes UUID 1 to 36 - Object ID. "DBB702C3-77

charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
name No string 1 to - Object name. "10"

255
charac
ters.
tenant No string - - Tenant name. "tenant1"

Name
tenantI No string 0 to - Tenant. The "DBB702C3-77

d 255 controller 19-4FE6-
charac automatically A5AD-3A9C9E2
ters. obtains the 65309"
tenant to
which the
logical router
belongs.

etwork 255 network. The 19-4FE6-
Id charac controller A5AD-3A9C9E2
ters. automatically 65309"
obtains the
logical network
to which the
logical router
belongs.
routerI No string 1 to - Logical router. "DBB702C3-77

d 255 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
router No string 1 to - Logical router "logicRouter00

Name 255 name. 1"
charac
ters.

charac router.
ters.

iMaster NCE-Fabric


255 IP address on a
charac VAS device.
ters.
mask No int64 - - Mask. 24

charac address on a 44:0000:0032/1
ters. router. 27"

charac address on a 44:0000:0032/1
ters. VAS device. 28"
maskv No int64 - - IPv6 mask. 64

6
vlan No int64 - - Interconnection 1

VLAN.
allcoM No string 0 to - Resource "automatic"

ode 255 allocation
charac mode.
ters. Currently, only
automatic
allocation is
supported.
extern No string 1 to - External "DBB702C3-77

alGate 255 gateway. 19-4FE6-
wayId charac A5AD-3A9C9E2
ters. 65309"
extern No string 1 to - External "DBB702C3-77

alNetw 255 network 19-4FE6-
orkId charac domain. A5AD-3A9C9E2
ters. 65309"
extern No string 0 to - External "aaa"

alNetw 255 network
orkNa charac domain name.
me ters.

iMaster NCE-Fabric

snatEn No boolea - false Whether to false

able n enable SNAT.
This function is
used to control
whether the
router needs to
perform
address
translation or
directly use the
private
network
address to
access an
external
network.
firewal No boolea - - Whether a -

lEnabl n logical router
e connected to
an external
gateway passes
through the
firewall.
logicV No string 0 to - Logical firewall "DBB702C3-77

asId 255 specified for an 19-4FE6-
charac external A5AD-3A9C9E2
ters. network 65309"
connection.
logicV No string 0 to - Logical firewall "vas001"

asNam 255 name.
e charac
ters.
ipv6En No boolea - - Whether to true

able n enable IPv6.
ipv6Fw No boolea - - Whether IPv6 true

Enable n traffic traverses
firewalls.
nat64P No array< 0-1 - NAT64 prefix. -

refixes string> items.
ipv4Ac No boolea - - Whether routes true

cessExt n are delivered
ernalE for IPv4 by
nable default.

iMaster NCE-Fabric

ipv6Ac No boolea - - Whether routes true

ernalE for IPv6 by
nable default.
localCi No array< 0-256 - Local network -

drs string> items. segment.
prefere No int32 [1-255 - Preference of a 230

nce ] route.
localPr No int32 [1-255 - Local priority 230

eferenc ] of a routing
e policy.
bgpPre No int32 [1-255 - BGP priority. 230

ference ]
flowRu No ARRAY For details, see - -

les _REFER Table 1-1275.
ENCE

Table 1-1275 FlowRuleDto parameters

id Yes string - - Flow rule ID. "12345678-123

4-1234-1234-1
234567890ab"
cidr Yes string - - Network "172.16.13.0/24

segment of the "
flow rule.
directi Yes string - - Direction. "ingress"

on
fwEna Yes boolea - - Whether the -

ble n firewall
function is
enabled.

iMaster NCE-Fabric

backha Yes boolea - - Whether a -

ulRout n route is a
eEnabl return route.
e


ters. condition.

At 255 0:11:16.000+00:
charac 00"
ters.

At 255 0:11:16.000+00:
charac 00"
ters.
Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/external-connects HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"external-connect" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"routerName" : "logicRouter001",
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.2",
"mask" : 24,
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128",
"maskv6" : 64,
"vlan" : 1,
"allcoMode" : "automatic",

iMaster NCE-Fabric
"externalNetworkName" : "aaa",
"snatEnable" : false,
"logicVasId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"logicVasName" : "vas001",
"ipv6Enable" : true,
"ipv6FwEnable" : true,
"nat64Prefixes" : [
"10.1.1.0/24"
],
"ipv4AccessExternalEnable" : true,
"localCidrs" : [
"10.1.1.1/24"
],
"preference" : 230,
"bgpPreference" : 230,
"flowRules" : [
{
"id" : "12345678-1234-1234-1234-1234567890ab",
"cidr" : "172.16.13.0/24",
"direction" : "ingress"
}
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.17.2 Query External Network Connections
Typical Scenarios
External network connections need to be queried.
Functions
Query external network connections based on the request information.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/external-connects

produc No string 0 to - Parameters for -

er 255 configuring a
charac condition.
ters.
tenantI No UUID - - Tenant ID. "DBB702C3-77

d 19-4FE6-
A5AD-3A9C9E2
65309"
logicR No UUID - - Logical router "DBB702C3-77

outerId ID. 19-4FE6-
A5AD-3A9C9E2
65309"
extNet No UUID - - External "DBB702C3-77

WorkId network ID. 19-4FE6-
A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

extern No UUID - - External "DBB702C3-77

alGate gateway ID. 19-4FE6-
wayId A5AD-3A9C9E2
65309"
exclud No string - - Producer that "mdc"

eProdu is not included.
cer

dex
pageSi No string - - Delete an "10"

ze External
Network
Connection
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/external-connects?tenantId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&extNetWorkId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&externalGatewayId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&excludeProducer=mdc&pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1278 ExternalConnectListRestfulDtoWrapper parameters

eter t Value
extern ARRAY For details, see Table - -

al- _REFER 1-1279.
connec ENCE
t

iMaster NCE-Fabric

eter t Value

um of results.

dex

ze
Table 1-1279 ExternalConnectDto parameters

eter t Value
id UUID 1 to 36 - Object ID. "DBB702C3-77

A5AD-3A9C9E2
65309"
name string 1 to 255 - Object name. "10"

characters.
tenant string - - Tenant name. "tenant1"

Name
tenantI string 0 to 255 - Tenant. The "DBB702C3-77

d characters. controller 19-4FE6-
obtains the 65309"
tenant to
which the
logical router
belongs.

etwork characters. network. The 19-4FE6-
Id controller A5AD-3A9C9E2
automatically 65309"
obtains the
logical network
to which the
logical router
belongs.
routerI string 1 to 255 - Logical router. "DBB702C3-77

A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
router string 1 to 255 - Logical router "logicRouter00

Name characters. name. 1"

router.

characters. IP address on a
VAS device.
mask int64 - - Mask. 24

address on a 44:0000:0032/1
router. 27"

address on a 44:0000:0032/1
VAS device. 28"
maskv int64 - - IPv6 mask. 64

6
vlan int64 - - Interconnection 1

VLAN.
allcoM string 0 to 255 - Resource "automatic"

ode characters. allocation
mode.
Currently, only
automatic
allocation is
supported.

alGate characters. gateway. 19-4FE6-
wayId A5AD-3A9C9E2
65309"

alNetw characters. network 19-4FE6-
orkId domain. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
extern string 0 to 255 - External "aaa"

alNetw characters. network
orkNa domain name.
me
snatEn boolea - false Whether to false

able n enable SNAT.
This function is
used to control
whether the
router needs to
perform
address
translation or
directly use the
private
network
address to
access an
external
network.
firewal boolea - - Whether a -

lEnabl n logical router
e connected to
an external
gateway passes
through the
firewall.
logicV string 0 to 255 - Logical firewall "DBB702C3-77

asId characters. specified for an 19-4FE6-
external A5AD-3A9C9E2
network 65309"
connection.
logicV string 0 to 255 - Logical firewall "vas001"

asNam characters. name.
e
ipv6En boolea - - Whether to true

able n enable IPv6.
ipv6Fw boolea - - Whether IPv6 true

Enable n traffic traverses
firewalls.
nat64P array< 0-1 items. - NAT64 prefix. -

refixes string>

iMaster NCE-Fabric

eter t Value
ipv4Ac boolea - - Whether routes true

ernalE for IPv4 by
nable default.
ipv6Ac boolea - - Whether routes true

ernalE for IPv6 by
nable default.
localCi array< 0-256 items. - Local network -

drs string> segment.
prefere int32 [1-255] - Preference of a 230

nce route.
localPr int32 [1-255] - Local priority 230

eferenc of a routing
e policy.
bgpPre int32 [1-255] - BGP priority. 230

ference
flowRu ARRAY For details, see Table - -

les _REFER 1-1280.
ENCE


eter t Value
id string - - Flow rule ID. "12345678-123

4-1234-1234-1
234567890ab"
cidr string - - Network "172.16.13.0/24

segment of the "
flow rule.
directi string - - Direction. "ingress"

on

iMaster NCE-Fabric

eter t Value
fwEna boolea - - Whether the -

ble n firewall
function is
enabled.
backha boolea - - Whether a -

ulRout n route is a
e

eter t Value

condition.

00"

00"
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",

iMaster NCE-Fabric
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.2",
"mask" : 24,
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128",
"maskv6" : 64,
"vlan" : 1,
"nat64Prefixes" : [
"10.1.1.0/24"
],
"localCidrs" : [
"10.1.1.1/24"
],
"preference" : 230,
"flowRules" : [
{
"id" : "12345678-1234-1234-1234-1234567890ab",
"cidr" : "172.16.13.0/24",
}
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
],
"totalNum" : 100,
"pageIndex" : 1,
"pageSize" : 4000
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.17.3 Query External Network Connections
Typical Scenarios
External network connections need to be queried.
Functions
Query an external network connection based on the condition information. The
query can be performed based on the ID.

iMaster NCE-Fabric
Constraints
HTTP Method
GET
URI
/controller/dc/v3/servicenetwork/external-connects/external-connect/{id}

id Yes UUID 1 to 36 - Specifies the ID "DBB702C3-77

charac of the external 19-4FE6-
ters. network A5AD-3A9C9E2
connection to 65309"
be queried.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/external-connects/external-connect/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1283 ExternalConnectRestfulDtoWrapper parameters

eter t Value

al- _REFER 1-1279.
connec ENCE
t
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.2",
"mask" : 24,
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128",
"maskv6" : 64,
"vlan" : 1,
"nat64Prefixes" : [
"10.1.1.0/24"
],
"localCidrs" : [
"10.1.1.1/24"
],
"preference" : 230,
"flowRules" : [

iMaster NCE-Fabric
{
"id" : "12345678-1234-1234-1234-1234567890ab",
"cidr" : "172.16.13.0/24",
}
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.17.4 Update an External Connection by ID (Only NAT64 Prefix Update Is

Supported)
Typical Scenarios
An external connection needs to be updated by ID.
Functions
Update an external connection by ID.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes UUID - - External "DBB702C3-77

connection ID. 19-4FE6-
A5AD-3A9C9E2
6530"
Request Parameters

dtId Yes string - - Distributed "G2019081217

transaction ID. 2342232_3483
090-
f93d-422d-
a0f6-54c95fb2
ba68d"

er Range Value on

NCE 1-1273. s for
updating
an
external
connectio
n.
Sample Request
HTTP
PUT /controller/dc/v3/servicenetwork/external-connects/external-connect/DBB702C3-7719-4FE6-
A5AD-3A9C9E26530 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
dtId: "G20190812172342232_3483090-f93d-422d-a0f6-54c95fb2ba68d"

iMaster NCE-Fabric
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.2",
"mask" : 24,
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128",
"maskv6" : 64,
"vlan" : 1,
"nat64Prefixes" : [
"10.1.1.0/24"
],
"localCidrs" : [
"10.1.1.1/24"
],
"preference" : 230,
"flowRules" : [
{
"id" : "12345678-1234-1234-1234-1234567890ab",
"cidr" : "172.16.13.0/24",
}
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Response Parameters
ExternalConnectRestfulDtoWrapper parameters, For details, see Table 1-1283.
Sample Response

iMaster NCE-Fabric
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "10",
"routerIp" : "10.1.1.1",
"vasIp" : "10.1.1.2",
"mask" : 24,
"routerIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/127",
"vasIpv6" : "FE80:0000:0000:0000:0000:0044:0000:0032/128",
"maskv6" : 64,
"vlan" : 1,
"nat64Prefixes" : [
"10.1.1.0/24"
],
"localCidrs" : [
"10.1.1.1/24"
],
"preference" : 230,
"flowRules" : [
{
"id" : "12345678-1234-1234-1234-1234567890ab",
"cidr" : "172.16.13.0/24",
}
],
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.17.5 Delete an External Network Connection
Typical Scenarios
An external network connection needs to be deleted.
Functions
Delete an external network connection based on the condition information. The
external network connection can be deleted based on the ID.
Constraints
HTTP Method
DELETE
URI

id Yes UUID 1 to 36 - ID of the "DBB702C3-77

charac external 19-4FE6-
ters. network A5AD-3A9C9E2
connection to 65309"
be deleted.


er Controller-
MDC"
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
DELETE /controller/dc/v3/servicenetwork/external-connects/external-connect/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309?producer=Agile-Controller-MDC HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.17.6 Add a Subnet to an External Network
Typical Scenarios
The address of a tenant to access an external network or the address of an
external network to a tenant needs to be added.
Functions
Add a subnet from an external network.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v3/servicenetwork/external-connects/external-connect/{id}/action/
add-cidrs

id Yes UUID 1 to 36 - ID of an "DBB702C3-77

ters. network to A5AD-3A9C9E2
which a subnet 65309"
belongs.
Request Parameters


090-
f93d-422d-
a0f6-54c95fb2
ba68d"

er Range Value on

NCE 1-1292. s for
adding a
subnet to
an
external
network.

iMaster NCE-Fabric
Table 1-1292 ExternalConnectCidrListRestfulDtoWrapper parameters

extern Yes ARRAY For details, see - -

al- _REFER Table 1-1293.
connec ENCE
t-cidr
Table 1-1293 ExternalConnectCidrDto parameters

cidrs Yes array< - - CIDR network -

string> segment.
cidrTyp Yes string 1 to 36 - CIDR type. "ingress/

e charac egress"
ters.

Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/external-connects/external-connect/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309/action/add-cidrs HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"external-connect-cidr" : [
{
"cidrs" : [
"10.1.1.1/24"
],
"cidrType" : "ingress/egress",
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}

iMaster NCE-Fabric
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.17.7 Remove a Subnet from an External Network
Typical Scenarios
external network to a tenant needs to be deleted.
Functions
Remove a subnet from an external network.
Constraints
HTTP Method
POST
URI
remove-cidrs

iMaster NCE-Fabric


belongs.
Request Parameters


090-
f93d-422d-
a0f6-54c95fb2
ba68d"

er Range Value on

NCE 1-1292. s for
removing
a subnet
from an
external
network.
Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/external-connects/external-connect/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309/action/remove-cidrs HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
{
"external-connect-cidr" : [
{
"cidrs" : [
"10.1.1.1/24"
],
"cidrType" : "ingress/egress",
"additional" : {
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00"
}
}
]
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.17.8 Query Subnets Connecting to an External Network
Typical Scenarios
external network to a tenant needs to be queried.
Functions
Query subnets connecting to an external network. By default, subnets are sorted
by cidrType and cidr.

iMaster NCE-Fabric
Constraints
HTTP Method
GET
URI
query-cidrs


belongs.

produc No string 0 to - Parameters for "CloudPlatform

er 255 configuring a 1"
charac condition.
ters.
cidrTyp No string - - Subnet type. "ingress/

e egress/
extEgress/
intIngress"

dex

ze
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v3/servicenetwork/external-connects/external-connect/DBB702C3-7719-4FE6-
A5AD-3A9C9E265309/action/query-cidrs?producer=CloudPlatform1&cidrType=ingress/egress/extEgress/
intIngress&pageIndex=1&pageSize=10 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1299 ExternalConnectCidrQueryListRestfulDtoWrapper parameters

eter t Value

al- _REFER 1-1300.
connec ENCE
t-flat-
cidr

um of results.

dex

ze
Table 1-1300 ExternalConnectFlatCidrDto parameters

eter t Value
cidr string - - Subnet "172.16.13.0/24

connected to "
an external
network.
cidrTyp string 1 to 36 - CIDR type. "ingress/

e characters. egress/ext-
egress/int-
ingress"

iMaster NCE-Fabric

eter t Value

00"

00"

condition.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"external-connect-flat-cidr" : [
{
"cidr" : "172.16.13.0/24",
"cidrType" : "ingress/egress/ext-egress/int-ingress",
"createAt" : "2016-10-05T20:11:16.000+00:00",
"updateAt" : "2016-10-05T20:11:16.000+00:00",
"producer" : "CloudPlatform1"
}
],
"totalNum" : 100,
"pageIndex" : 1,
"pageSize" : 4000
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.18 DHCP Group Management

# DHCP group management interface description
1. Query the DHCP group list.

iMaster NCE-Fabric
2. If the DHCP server connects to the M-LAG consisting of access switches, the
loopback interface cannot be used.
1.9.7.18.1 Create a DHCP Group
Typical Scenarios
A DHCP group needs to be created.
Functions
Create DHCP groups based on parameters.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/publicservice/dhcpgroups
Request Parameters

er Range Value on

NCE 1-1302. s for
udpating
a DHCP
group.
Table 1-1302 DhcpGroupsDtoWrapper parameters

dhcpgr Yes ARRAY For details, see Create a VPC -

oup _REFER Table 1-1303. Connection
ENCE

iMaster NCE-Fabric
Table 1-1303 DhcpGroupDto parameters

id Yes string 0 to - DHCP server "DBB702C3-77

256 ID. This field 19-4FE6-
name Yes string 1 to - DHCP server "dhcpserver1"

255 name. This
charac field can be
ters. updated.
descrip No string 0 to - Description. "description1"

tion 255 This field can
charac be updated.
ters.
logicR No string 0 to - ID of the "DBB702C3-77

outerId 256 logical router 19-4FE6-
ters. DHCP server 65309"
belongs. Either
the DHCP
server or the
VRF name
needs to be
set. This field
cannot be
updated.
vrfNa No string 0 to 31 - VRF name of "vrfname"

me charac the logical
ters. router to which
the DHCP
server belongs.
Either the VRF
name or the
logical router
ID needs to be
set. This field
cannot be
updated.
serverI Yes array< 1-4000 - DHCP server ["192.168.192.

p string> items. address. This 1"]
field can be
updated.

iMaster NCE-Fabric

dhcpgr No ARRAY For details, see IP address pool -

oupl2v _REFER Table 1-1304. of the DHCP
ni ENCE server.

specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
device No ARRAY For details, see Device group -

GroupI _REFER Table 1-1305. information to
nfos ENCE be delivered.
This parameter
is optional. A
maximum of
two device
groups can be
specified. All of
the
deviceGroupInf
os, l3Vni, and
routeTarget
parameters
must be set or
left empty.

iMaster NCE-Fabric

l3Vni No int32 [0-214 0 DHCP Layer 3 10

74836 VNI. This
47] parameter is
optional. The
value can be
changed. All of
the
deviceGroupInf
os, l3Vni, and
routeTarget
parameters
must be set or
left empty.
routeT No string 0 to - Route target "0:5006"

arget 255 specified by a
charac user. The value
ters. can be
changed. All of
the
deviceGroupInf
os, l3Vni, and
routeTarget
parameters
must be set or
left empty.
Table 1-1304 DhcpGroupL2vniDto parameters

l2Vni Yes int32 [0-214 0 DHCP L2 VNI. 10

74836 This field can
47] be updated.
ipv4Ci No string 0 to - DHCP IPv4 "192.168.168.0/

dr 255 CIDR. This field 24"
charac can be
ters. updated.
ipv6Ci No string 1 to 31 - DHCP IPv6 "FE80::/126"

dr charac CIDR. This field
ters. can be
updated.

iMaster NCE-Fabric
Table 1-1305 DeviceGroupInfoDto parameters

device Yes string 1 to 36 - ID of the "DBB702C3-77

GroupI charac device group to 19-4FE6-
d ters. be delivered. A5AD-3A9C9E2
The value can 65309"
be changed.
device No string 1 to - Name of the "CE_45"

Group 255 device group to
Name charac be delivered.
ters. This parameter
is used only for
query and
display.
Sample Request
HTTP
POST /controller/dc/v3/publicservice/dhcpgroups HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"dhcpgroup" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "dhcpserver1",
"description" : "description1",
"vrfName" : "vrfname",
"serverIp" : ["192.168.192.1"],
"dhcpgroupl2vni" : [
{
"l2Vni" : 10,
"ipv4Cidr" : "192.168.168.0/24",
"ipv6Cidr" : "FE80::/126"
}
],
"deviceGroupInfos" : [
{
"deviceGroupName" : "CE_45"
}
],
"l3Vni" : 10,
"routeTarget" : "0:5006"
}
]
}

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.18.2 Query DHCP Groups
Typical Scenarios
DHCP groups need to be queried.
Functions
Query DHCP groups based on the search criteria. Query by page is supported.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/publicservice/dhcpgroups

iMaster NCE-Fabric


dex 255
charac
ters.
pageSi No string [1-400 - Page size. "1"

ze 0]
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/publicservice/dhcpgroups?pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1307 DhcpGroupsPagedDtoWrapper parameters

eter t Value
dhcpgr ARRAY For details, see Table Create a VPC -

oup _REFER 1-1308. Connection
ENCE


dex 2147483647
characters.

ze 2147483647
characters.

iMaster NCE-Fabric
Table 1-1308 DhcpGroupDto parameters

eter t Value
id string 0 to 256 - DHCP server "DBB702C3-77

characters. ID. This field 19-4FE6-
updated. 65309"
name string 1 to 255 - DHCP server "dhcpserver1"

characters. name. This
field can be
updated.
descrip string 0 to 255 - Description. "description1"

tion characters. This field can
be updated.
logicR string 0 to 256 - ID of the "DBB702C3-77

outerId characters. logical router 19-4FE6-
to which the A5AD-3A9C9E2
DHCP server 65309"
belongs. Either
the DHCP
server or the
VRF name
needs to be
set. This field
cannot be
updated.
vrfNa string 0 to 31 - VRF name of "vrfname"

me characters. the logical
router to which
the DHCP
server belongs.
Either the VRF
name or the
logical router
ID needs to be
set. This field
cannot be
updated.
serverI array< 1-4000 items. - DHCP server ["192.168.192.

p string> address. This 1"]
field can be
updated.
dhcpgr ARRAY For details, see Table IP address pool -

oupl2v _REFER 1-1309. of the DHCP
ni ENCE server.

iMaster NCE-Fabric

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

GroupI _REFER 1-1310. information to
nfos ENCE be delivered.
This parameter
is optional. A
maximum of
two device
groups can be
specified. All of
the
deviceGroupInf
os, l3Vni, and
routeTarget
parameters
must be set or
left empty.
l3Vni int32 [0-2147483647 0 DHCP Layer 3 10

] VNI. This
parameter is
optional. The
value can be
changed. All of
the
deviceGroupInf
os, l3Vni, and
routeTarget
parameters
must be set or
left empty.

iMaster NCE-Fabric

eter t Value
routeT string 0 to 255 - Route target "0:5006"

arget characters. specified by a
user. The value
can be
changed. All of
the
deviceGroupInf
os, l3Vni, and
routeTarget
parameters
must be set or
left empty.
Table 1-1309 DhcpGroupL2vniDto parameters

eter t Value
l2Vni int32 [0-2147483647 0 DHCP L2 VNI. 10

] This field can
be updated.
ipv4Ci string 0 to 255 - DHCP IPv4 "192.168.168.0/

dr characters. CIDR. This field 24"
can be
updated.
ipv6Ci string 1 to 31 - DHCP IPv6 "FE80::/126"

dr characters. CIDR. This field
can be
updated.
Table 1-1310 DeviceGroupInfoDto parameters

eter t Value
device string 1 to 36 - ID of the "DBB702C3-77

GroupI characters. device group to 19-4FE6-
d be delivered. A5AD-3A9C9E2
The value can 65309"
be changed.

iMaster NCE-Fabric

eter t Value
device string 1 to 255 - Name of the "CE_45"

Group characters. device group to
Name be delivered.
This parameter
is used only for
query and
display.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"dhcpgroup" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"serverIp" : ["192.168.192.1"],
{
"l2Vni" : 10,
"ipv4Cidr" : "192.168.168.0/24",
"ipv6Cidr" : "FE80::/126"
}
],
{
}
],
"l3Vni" : 10,
}
],
"totalNum" : 1,
"pageIndex" : 1,
"pageSize" : 1
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.18.3 Query a DHCP Group by ID
Typical Scenarios
A DHCP group needs to be queried by ID.
Functions
Query a DHCP group by ID.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/publicservice/dhcpgroups/dhcpgroup/{id}


charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/publicservice/dhcpgroups/dhcpgroup/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-1312 DhcpGroupsDtoWrapper parameters

eter t Value
dhcpgr ARRAY For details, see Table Create a VPC -

oup _REFER 1-1308. Connection
ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"dhcpgroup" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"serverIp" : ["192.168.192.1"],
{
"l2Vni" : 10,
"ipv4Cidr" : "192.168.168.0/24",
"ipv6Cidr" : "FE80::/126"
}
],
{
}
],
"l3Vni" : 10,
}
]
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.18.4 Update a DHCP Group
Typical Scenarios
A DHCP group needs to be updated.
Functions
Update a DHCP group.
Constraints
HTTP Method
PUT
URI


charac A5AD-3A9C9E2
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-1302. s for
udpating
a DHCP
group.
Sample Request
HTTP
PUT /controller/dc/v3/publicservice/dhcpgroups/dhcpgroup/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"dhcpgroup" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"serverIp" : ["192.168.192.1"],
{
"l2Vni" : 10,
"ipv4Cidr" : "192.168.168.0/24",
"ipv6Cidr" : "FE80::/126"
}
],
{
}
],
"l3Vni" : 10,
}
]
}
Response Parameters
DhcpGroupsDtoWrapper parameters, For details, see Table 1-1312.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"dhcpgroup" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"serverIp" : ["192.168.192.1"],
{
"l2Vni" : 10,
"ipv4Cidr" : "192.168.168.0/24",
"ipv6Cidr" : "FE80::/126"
}
],
{
}
],
"l3Vni" : 10,
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.18.5 Delete a DHCP Group
Typical Scenarios
A DHCP group needs to be deleted.
Functions
Delete a DHCP group.

iMaster NCE-Fabric
Constraints
HTTP Method
DELETE
URI


charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/publicservice/dhcpgroups/dhcpgroup/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.19 Flow Rule

# External connection flow rule API description: 1.Create a flow rule. 2.Delete a
flow rule.
1.9.7.19.1 Create a Flow Rule
Typical Scenarios
A flow rule needs to be created.
Functions
Create a flow rule based on the request information.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/servicenetwork/flow-rule/{extConId}/add

extCon Yes UUID - - External "12345678-123

Id connection ID. 4-1234-1234-1
234567890ab"

iMaster NCE-Fabric
Request Parameters

er Range Value on

NCE 1-1318. s for
creating a
flow rule.

id Yes string - - Flow rule ID. "12345678-123

4-1234-1234-1
234567890ab"
cidr Yes string - - Network "172.16.13.0/24

segment of the "
flow rule.
directi Yes string - - Direction. "ingress"

on
fwEna Yes boolea - - Whether the -

ble n firewall
function is
enabled.
backha Yes boolea - - Whether a -

ulRout n route is a
e
Sample Request
HTTP
POST /controller/dc/v3/servicenetwork/flow-rule/12345678-1234-1234-1234-1234567890ab/add HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "12345678-1234-1234-1234-1234567890ab",
"cidr" : "172.16.13.0/24",

iMaster NCE-Fabric
}
Response Parameters
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.19.2 Delete a Flow Rule
Typical Scenarios
Delete a Flow Rule.
Functions
Delete a flow rule based on the ID.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/servicenetwork/flow-rule/{extConId}/remove/{id}

iMaster NCE-Fabric

extCon Yes UUID - - External "12345678-123

Id connection ID. 4-1234-1234-1
234567890ab"
id Yes UUID - - ID for deleting "12345678-123

an external 4-1234-1234-1
network 234567890ab"
connection.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/servicenetwork/flow-rule/12345678-1234-1234-1234-1234567890ab/remove/
12345678-1234-1234-1234-1234567890ab HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.20 DHCP Relay Management of Subnet

# DHCP relay management APIs
1.9.7.20.1 Associate a Subnet with a DHCP Group
Typical Scenarios
A subnet needs to be associated with a DHCP group.
Functions
Associate a subnet with a DHCP group.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/subnet-dhcprelay
Request Parameters

er Range Value on

NCE 1-1321. s for
udpating
a DHCP
group.

iMaster NCE-Fabric
Table 1-1321 SubnetDHCPRelayDtoWrapper parameters

subnet Yes ARRAY For details, see - -

DhcpR _REFER Table 1-1322.
elay ENCE
Table 1-1322 SubnetDHCPRelayDto parameters

subnet Yes UUID 1 to 36 - Object ID. "DBB702C3-77

Id charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
dhcpGr Yes UUID 0 to - DHCP server "DBB702C3-77

oupId 255 group 19-4FE6-
charac associated with A5AD-3A9C9E2
ters. the subnet. 65309"
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/subnet-dhcprelay HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"subnetDhcpRelay" : [
{
}
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.20.2 Disassociate a Subnet from a DHCP Group
Typical Scenarios
A subnet needs to be disassociated from a DHCP group.
Functions
Disassociate a subnet from a DHCP group.
Constraints
HTTP Method
DELETE
URI
/controller/dc/v3/logicnetwork/subnet-dhcprelay/{subnet-id}

subnet Yes UUID 1 to 36 - ID for deleting "DBB702C3-77

-id charac a DHCP group. 19-4FE6-
ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/subnet-dhcprelay/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.21 Logical Router Configuration Management

# APIs for managing the device group configuration services of a logical router: 1.
Query all the device group configuration services of a logical router, including the
best-effort path and FRR. 2. Create a device group configuration service on a
logical router, including the best-effort path and FRR. 3. Query details on a device
group configuration service of a logical router, including the best-effort path and
FRR. 4. Update a device group configuration service of a logical router, including
the best-effort path and FRR. 5. Delete a device group configuration service from
a logical router, including the best-effort path and FRR.

iMaster NCE-Fabric
1.9.7.21.1 Create a Device Group Configuration Service on a Logical Router,

Including the Best-Effort Path and FRR
Typical Scenarios
A device group configuration service needs to be created on a logical router.
Functions
Create a device group configuration service on a logical router.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/router/devicecfgs
Request Parameters


device group
configuration
service on a
logical router.
Table 1-1325 RouterDeviceCfgDtoWrapper parameters

Router No REFER For details, see Logical router -

Device ENCE Table 1-1326. information.
Cfg

iMaster NCE-Fabric
Table 1-1326 RouterDeviceCfgDto parameters

id Yes string 0 to - Object ID of "dc417c43-442

256 the device 6-4244-
charac group be45-44b0c6ff
ters. configuration 2864"
service on a
logical router.
name No string 1 to - ID of the "name1"

255 associated
charac logical router.
ters. This field
cannot be
updated.
descrip No string 0 to - Description. "10"

tion 255 This field can
charac be updated.
ters.
logicR Yes string 0 to - ID of the "dc417c43-442

outerId 256 associated 6-4244-
charac logical router. be45-44b0c6ff
cannot be
updated.
device No string 0 to - ID of the "dc417c43-442

GroupI 256 device group. 6-4244-
d charac Either the be45-44b0c6ff
ters. device group 2864"
ID or device
management
IP address can
be set. This
field cannot be
updated.

iMaster NCE-Fabric

deviceI No array< 0-255 - Device ["192.168.1.1"]

ps string> items. management
IP address list,
which must
include the
management
IP addresses of
all devices in
the same
device group.
Either the
device
management
IP address or
the device
group ID can
be set. This
field cannot be
updated.
enable No boolea - - Whether to false

Escape n enable the
best-effort
path. This field
can be
updated.

Frr n enable FRR.
This field can
be updated.
escape No string - - Whether to "Unknown"

IpVersi deliver BGP
on configurations.
This field
cannot be
updated.

Escape n deliver BGP
Bgp configurations.
This field
cannot be
updated.
extInte No string - - API type. This "Vbdif"

rfaceTy field cannot be
pe updated.

iMaster NCE-Fabric


Null0R n enable black-
oute hole route. This
field can be
updated.
null0Ip No string - - Indicates "Ipv4"

Versio whether to
n enable the DCI
routing policy.
escape No string 0 to 20 - Best-effort "manual"

Mode charac path mode.
ters. manual:
manual;
automatic:
automatic.
escape No int32 [2-409 - Manually 2000

Vlan 4] specified VLAN
ID.
escape No ARRAY 0-2 items. For IP address of -

IpList _REFER details, see the device that
ENCE Table 1-1327. is manually
specified.
enable No boolea - - Indicates false

DciRou n whether to
tePolic enable the DCI
y routing policy.
dciApp No array< - - apply -

lyRTs string> extcommunity
rt information
configured on
the node in the
routing policy.


iMaster NCE-Fabric
Table 1-1327 EscapeIpDto parameters

deviceI No string 0 to 36 - Device ID. "e22e0885-6c0

d charac 5-4cc1-8ddc-
ters. b7d0a21edbf3"
ipv4 No string 0 to - IPv4 address of "10.1.1.1/30"

200 the best-effort
charac path.
ters.
ipv6 No string 0 to - IPv6 address of "fc00::1/7"

200 the best-effort
charac path.
ters.


specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 16:30:40"
charac
ters.

At 255 16:30:40"
charac
ters.

iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/router/devicecfgs HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"RouterDeviceCfg" : {
"id" : "dc417c43-4426-4244-be45-44b0c6ff2864",
"name" : "name1",
"logicRouterId" : "dc417c43-4426-4244-be45-44b0c6ff2864",
"deviceGroupId" : "dc417c43-4426-4244-be45-44b0c6ff2864",
"deviceIps" : ["192.168.1.1"],
"enableEscape" : false,
"enableFrr" : false,
"enableEscapeBgp" : false,
"enableNull0Route" : false,
"null0IpVersion" : "Ipv4",
"escapeMode" : "manual",
"escapeVlan" : 2000,
"escapeIpList" : [
{
"deviceId" : "e22e0885-6c05-4cc1-8ddc-b7d0a21edbf3",
"ipv4" : "10.1.1.1/30",
"ipv6" : "fc00::1/7"
}
],
"enableDciRoutePolicy" : false,
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.21.2 Query Device Group Configuration Services of a Logical Router, Including

the Best-Effort Path and FRR
Typical Scenarios
Device group configuration services of a logical router need to be queried.
Functions
Query all device group configuration services of a logical router under a specified
condition.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/router/devicecfgs


ze 255
charac
ters.

dex 255 number.
charac
ters.
logicR No string 0 to - ID of the "dc417c43-442

charac Layer 3 logical be45-44b0c6ff
ters. router. 2864"

iMaster NCE-Fabric

device No string 0 to - ID of the "dc417c43-442

GroupI 256 device group. 6-4244-
d charac Either the be45-44b0c6ff
ters. device 2864"
management
IP address or
the device
group ID can
be set.
deviceI No string - - Management "192.168.1.1"

p IP address of
the device.
Either the
device
management
IP address or
the device
group ID can
be set.

specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/router/devicecfgs?
pageSize=10&pageIndex=1&logicRouterId=dc417c43-4426-4244-
be45-44b0c6ff2864&deviceGroupId=dc417c43-4426-4244-
be45-44b0c6ff2864&deviceIp=192.168.1.1&producer=default HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1330 RouterDeviceCfgDtoListWrapper parameters

eter t Value
Router ARRAY 0-4000 items. For details, Logical router -

Device _REFER see Table 1-1331. information
Cfgs ENCE list.

um ] of queried
results in the
device group
configuration
service list of a
logical router.
pageIn int32 [1-4000] - Current page 1

dex number.

ze
Table 1-1331 RouterDeviceCfgDto parameters

eter t Value
id string 0 to 256 - Object ID of "dc417c43-442

characters. the device 6-4244-
group be45-44b0c6ff
configuration 2864"
service on a
logical router.
name string 1 to 255 - ID of the "name1"

characters. associated
logical router.
This field
cannot be
updated.

iMaster NCE-Fabric

eter t Value
descrip string 0 to 255 - Description. "10"

tion characters. This field can
be updated.
logicR string 0 to 256 - ID of the "dc417c43-442

outerId characters. associated 6-4244-
logical router. be45-44b0c6ff
This field 2864"
cannot be
updated.
device string 0 to 256 - ID of the "dc417c43-442

GroupI characters. device group. 6-4244-
d Either the be45-44b0c6ff
device group 2864"
ID or device
management
IP address can
be set. This
field cannot be
updated.
deviceI array< 0-255 items. - Device ["192.168.1.1"]

ps string> management
IP address list,
which must
include the
management
IP addresses of
all devices in
the same
device group.
Either the
device
management
IP address or
the device
group ID can
be set. This
field cannot be
updated.
enable boolea - - Whether to false

Escape n enable the
best-effort
path. This field
can be
updated.

iMaster NCE-Fabric

eter t Value

Frr n enable FRR.
This field can
be updated.
escape string - - Whether to "Unknown"

IpVersi deliver BGP
on configurations.
This field
cannot be
updated.

Escape n deliver BGP
Bgp configurations.
This field
cannot be
updated.
extInte string - - API type. This "Vbdif"

rfaceTy field cannot be
pe updated.

Null0R n enable black-
oute hole route. This
field can be
updated.
null0Ip string - - Indicates "Ipv4"

Versio whether to
n enable the DCI
routing policy.
escape string 0 to 20 - Best-effort "manual"

Mode characters. path mode.
manual:
manual;
automatic:
automatic.
escape int32 [2-4094] - Manually 2000

Vlan specified VLAN
ID.
escape ARRAY 0-2 items. For details, see IP address of -

IpList _REFER Table 1-1332. the device that
ENCE is manually
specified.

iMaster NCE-Fabric

eter t Value
enable boolea - - Indicates false

DciRou n whether to
y routing policy.
dciApp array< - - apply -

rt information
configured on
the node in the
routing policy.

Table 1-1332 EscapeIpDto parameters

eter t Value
deviceI string 0 to 36 - Device ID. "e22e0885-6c0

d characters. 5-4cc1-8ddc-
b7d0a21edbf3"
ipv4 string 0 to 200 - IPv4 address of "10.1.1.1/30"

characters. the best-effort
path.
ipv6 string 0 to 200 - IPv6 address of "fc00::1/7"

characters. the best-effort
path.

iMaster NCE-Fabric

eter t Value

optional. If it is
specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.


Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"RouterDeviceCfgs" : [
{
"id" : "dc417c43-4426-4244-be45-44b0c6ff2864",
"name" : "name1",
"deviceIps" : ["192.168.1.1"],

iMaster NCE-Fabric
"escapeIpList" : [
{
"ipv4" : "10.1.1.1/30",
"ipv6" : "fc00::1/7"
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
],
"totalNum" : 200,
"pageIndex" : 1,
"pageSize" : 4000
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.21.3 Configuring Service Parameters for a Logical Router Group, Including

Best-Effort Path and FRR
Typical Scenarios
Service parameters for a logical router group need to be configured.
Functions
Update service parameters for a device group based on the logical router ID,
device group ID, or device management IP address.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/router/devicecfgs/setparams

iMaster NCE-Fabric
Request Parameters


configuring
services for a
logical router
group.
Table 1-1335 RouterDevCfgParamWrapper parameters

Router No REFER For details, see Router -

Device ENCE Table 1-1336. information.
Cfg
Table 1-1336 RouterDevCfgParamDto parameters

logicR Yes string 0 to - ID of the "dc417c43-442

charac logical router. be45-44b0c6ff
ters. 2864"
device No string 0 to - ID of a "dc417c43-442

GroupI 256 specified device 6-4244-
d charac group. Either be45-44b0c6ff
ters. the device 2864"
group ID or the
device
management
IP address
must be
specified.

iMaster NCE-Fabric

deviceI No array< 0-255 - List of device ["192.168.1.1"]

ps string> items. management
IP addresses,
which must be
the
management
IP addresses of
all devices in
the same
device group.
Either the
device
management
IP address or
the device
group ID must
be specified.
enable No boolea - - Whether the false

Escape n best-effort
path is
enabled.
enable No boolea - - Whether FRR is false

Frr n enabled.
escape No string - - IP address type "Unknown"

IpVersi of the best-
on effort path.
The value can
be Ipv4, Ipv6,
or Unknown. If
this parameter
is left empty,
Unknown is
used. This field
can be
updated.
enable No boolea - - Whether BGP false

Escape n configurations
Bgp are delivered.
extInte No string - - Interface type. "Vbdif"

rfaceTy
pe

iMaster NCE-Fabric

enable No boolea - - Whether the false

Null0R n blackhole route
oute is enabled.
null0Ip No string - - IP address type "Ipv4"

Versio of the best-
n effort path.
The value can
be Ipv4, Ipv6,
or Unknown. If
this parameter
is left empty,
Unknown is
used. This field
can be
updated.
enable No boolea - - Indicates false

DciRou n whether to
y routing policy.
escape No string 0 to 20 - Best-effort "manual"

Mode charac path mode.
ters. manual:
manual;
automatic:
automatic.
escape No int32 [2-409 - Manually 2000

Vlan 4] specified VLAN
ID.
escape No ARRAY 0-2 items. For IP address of -

IpList _REFER details, see the device that
ENCE Table 1-1327. is manually
specified.
dciApp No array< - - apply -

rt information
configured on
the node in the
routing policy.


iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/router/devicecfgs/setparams HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"deviceIps" : ["192.168.1.1"],
"escapeIpList" : [
{
"ipv4" : "10.1.1.1/30",
"ipv6" : "fc00::1/7"
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.21.4 Query a Device Group Configuration Service by ID on a Logical Router,

Typical Scenarios
A device group configuration service needs to be queried by ID on a logical router.
Functions
Query a device group configuration service by ID on a logical router.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/router/devicecfgs/devicecfg/{id}

id Yes string 0 to - Query a device "dc417c43-442

256 group 6-4244-
charac configuration be45-44b0c6ff
ters. service by ID 2864"
on a logical
router.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/router/devicecfgs/devicecfg/dc417c43-4426-4244-be45-44b0c6ff2864
HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1338 RouterDeviceCfgDtoWrapper parameters

eter t Value
Router REFER For details, see Table Logical router -

Device ENCE 1-1331. information.
Cfg
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "dc417c43-4426-4244-be45-44b0c6ff2864",
"name" : "name1",
"deviceIps" : ["192.168.1.1"],
"escapeIpList" : [
{
"ipv4" : "10.1.1.1/30",
"ipv6" : "fc00::1/7"
}
],
"additional" : {

iMaster NCE-Fabric
"createAt" : "2017-08-10 16:30:40",

"updateAt" : "2017-08-10 16:30:40"
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.21.5 Update a Device Group Configuration Service by ID on a Logical Router,

Typical Scenarios
A device group configuration service needs to be updated by ID on a logical router.
Functions
Update a device group configuration service by ID on a logical router.
Constraints
HTTP Method
PUT
URI

id Yes string 0 to - ID for updating "dc417c43-442

256 a device group 6-4244-
ters. service on a 2864"
logical router.

iMaster NCE-Fabric
Request Parameters


er ENCE Table 1-1325. updating a
device group
configuration
service on a
logical router.
The values of
logicRouterId,
deviceIps, and
deviceGroupId
cannot be
updated.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/router/devicecfgs/devicecfg/dc417c43-4426-4244-be45-44b0c6ff2864
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "dc417c43-4426-4244-be45-44b0c6ff2864",
"name" : "name1",
"deviceIps" : ["192.168.1.1"],
"escapeIpList" : [
{
"ipv4" : "10.1.1.1/30",
"ipv6" : "fc00::1/7"
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",

iMaster NCE-Fabric
"updateAt" : "2017-08-10 16:30:40"

}
}
}
Response Parameters
RouterDeviceCfgDtoWrapper parameters, For details, see Table 1-1338.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "dc417c43-4426-4244-be45-44b0c6ff2864",
"name" : "name1",
"deviceIps" : ["192.168.1.1"],
"escapeIpList" : [
{
"ipv4" : "10.1.1.1/30",
"ipv6" : "fc00::1/7"
}
],
"additional" : {
"createAt" : "2017-08-10 16:30:40",
"updateAt" : "2017-08-10 16:30:40"
}
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
1.9.7.21.6 Delete a Device Group Configuration Service by ID from a Logical Router,

Typical Scenarios
A device group configuration service needs to be deleted by ID from a logical
router.
Functions
ID for deleting a device group configuration service from a logical router.
Constraints
HTTP Method
DELETE
URI

id Yes string 0 to - ID for deleting "dc417c43-442

256 a device group 6-4244-
ters. service from a 2864"
logical router.

iMaster NCE-Fabric

produc No string 0 to 36 - This parameter "North"

er charac is optional. If it
ters. is specified by
a user, the
user-specified
value is used. If
it is not
specified, the
default value
North is used.
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/router/devicecfgs/devicecfg/dc417c43-4426-4244-
be45-44b0c6ff2864?producer=North HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.22 Loopback Interface Management

Loopback interface APIs:
1. Add, delete, modify, and query loopback interfaces.
2. Query loopback interfaces created by using APIs.
3. Configure loopback interfaces for specified devices.
1.9.7.22.1 Create a Loopback Interface
Typical Scenarios
A loopback interface needs to be created.
Functions
Create a loopback interface.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/loopbacks
Request Parameters

er Range Value on

r model
class for
creating a
loopback
interface.

iMaster NCE-Fabric
Table 1-1344 LoopbackDtoWrapper parameters

loopba Yes ARRAY For details, see "" -

ck _REFER Table 1-1345.
ENCE
Table 1-1345 LoopbackDto parameters

id Yes string 1 to 36 - Object ID. This "DBB702C3-77

65309"
name No string 1 to - Loopback "bfd1"

255 interface name,
charac which can be
ters. updated.

tion 255 This field can tenant1."
charac be updated.
ters.
owner No int32 - - Type of the 1

Type object to which
the loopback
interfaces
belong. 1:
Logical router.
2: External
gateway. This
parameter
cannot be
updated.
routerI No string 1 to 36 - Associated "DBB702C3-77

d charac logicRouterId 19-4FE6-
ters. or external A5AD-3A9C9E2
gateway's 65309"
LogicRouterId,
which cannot
be updated.

iMaster NCE-Fabric

loopba No string [1-214 - Loopback "200"

ckId 74836 interface ID,
47] which can be
specified. If it is
not specified,
the controller
automatically
allocates a
loopback
interface ID
based on the
device group
resource pool.
This parameter
cannot be
updated.
ip No array< 0-255 - Loopback -

string> items. interface IP
addresses, in
CIDR format.
The maximum
number of IPv4
and IPv6
addresses
configured for
each loopback
interface is
subject to the
number of
valid device
groups.
device No string 1 to 36 - Device group, "DBB702C3-77

GroupI charac which cannot 19-4FE6-
d ters. be updated. A5AD-3A9C9E2
65309"
device No ARRAY For details, see Devices for -

List _REFER Table 1-1346. which loopback
ENCE IP addresses
are configured.
This parameter
is optional. If it
is not specified,
the controller
automatically
allocates
devices.

iMaster NCE-Fabric
Table 1-1346 deviceList parameters

deviceI Yes string 1 to 36 - Device ID. "DBB702C3-77

d charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
ip No array< 0-255 - Loopback -

string> items. interface IP
addresses
deployed on
the local
device, in CIDR
format.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/loopbacks HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"loopback" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"ownerType" : 1,
"loopbackId" : "200",
"ip" : [
"192.168.1.0/24"
],
"deviceList" : [
{
"ip" : [
"192.168.1.0/24"
]
}
]
}
]
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.22.2 Query the Loopback Interface List
Typical Scenarios
The loopback interface list needs to be queried.
Functions
Query the loopback interface list by condition.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/loopbacks

iMaster NCE-Fabric

owner No int32 - - Type of the 1

the loopback
interfaces to be
queried belong.
1: Logical
router. 2:
External
gateway.
routerI No string 1 to 36 - Associated "DBB702C3-77

d charac logicRouterId 19-4FE6-
ters. or external A5AD-3A9C9E2
gateway's 65309"
LogicRouterId.
loopba No string [1-214 - Loopback "200"

ckId 74836 interface ID.
47]

dex 255
charac
ters.

ze 255
charac
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/loopbacks?ownerType=1&routerId=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309&loopbackId=200&pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1348 LoopbackPagedDtoWrapper parameters

eter t Value
loopba ARRAY For details, see Table "" -

ck _REFER 1-1349.
ENCE

um ] of loopback
interfaces
queried.

dex

ze
Table 1-1349 LoopbackDto parameters

eter t Value

65309"
name string 1 to 255 - Loopback "bfd1"

characters. interface name,
which can be
updated.

tion characters. This field can tenant1."
be updated.
owner int32 - - Type of the 1

the loopback
interfaces
belong. 1:
Logical router.
2: External
gateway. This
parameter
cannot be
updated.

iMaster NCE-Fabric

eter t Value
routerI string 1 to 36 - Associated "DBB702C3-77

d characters. logicRouterId 19-4FE6-
or external A5AD-3A9C9E2
gateway's 65309"
LogicRouterId,
which cannot
be updated.
loopba string [1-2147483647 - Loopback "200"

ckId ] interface ID,
which can be
specified. If it is
not specified,
the controller
automatically
allocates a
loopback
interface ID
based on the
device group
resource pool.
This parameter
cannot be
updated.
ip array< 0-255 items. - Loopback -

string> interface IP
addresses, in
CIDR format.
The maximum
number of IPv4
and IPv6
addresses
configured for
each loopback
interface is
subject to the
number of
valid device
groups.
device string 1 to 36 - Device group, "DBB702C3-77

GroupI characters. which cannot 19-4FE6-
d be updated. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric

eter t Value
device ARRAY For details, see Table Devices for -

List _REFER 1-1350. which loopback
ENCE IP addresses
are configured.
This parameter
is optional. If it
is not specified,
the controller
automatically
allocates
devices.
Table 1-1350 deviceList parameters

eter t Value

A5AD-3A9C9E2
65309"
ip array< 0-255 items. - Loopback -

string> interface IP
addresses
deployed on
the local
device, in CIDR
format.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"loopback" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"name" : "bfd1",
"ownerType" : 1,
"ip" : [
"192.168.1.0/24"
],
"deviceList" : [
{
"ip" : [
"192.168.1.0/24"
]
}
]
}
],
"totalNum" : 200,
"pageIndex" : 10,
"pageSize" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.22.3 Query a Loopback Interface
Typical Scenarios
A loopback interface needs to be queried.
Functions
Query a loopback interface.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/loopbacks/loopback/{id}

iMaster NCE-Fabric

id Yes string 1 to 36 - ID used for the "DBB702C3-77

ters. A5AD-3A9C9E2
65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/loopbacks/loopback/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1352 LoopbackDtoWrapper parameters

eter t Value
loopba ARRAY For details, see Table "" -

ck _REFER 1-1349.
ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"loopback" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"ownerType" : 1,
"ip" : [
"192.168.1.0/24"
],
"deviceList" : [
{
"ip" : [
"192.168.1.0/24"
]
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.22.4 Update a Loopback Interface
Typical Scenarios
A loopback interface needs to be updated.
Functions
Update a loopback interface by ID. Parameters of a loopback interface can be
modified only when no services reference the loopback interface.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes string 1 to 36 - ID of the "DBB702C3-77

charac loopback 19-4FE6-
ters. interface to be A5AD-3A9C9E2
updated. 65309"
Request Parameters

er Range Value on

r model
class for
updating
a
loopback
interface.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/loopbacks/loopback/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"loopback" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"ownerType" : 1,
"ip" : [
"192.168.1.0/24"
],
"deviceList" : [
{
"ip" : [
"192.168.1.0/24"

iMaster NCE-Fabric
]
}
]
}
]
}
Response Parameters
LoopbackDtoWrapper parameters, For details, see Table 1-1352.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"loopback" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"ownerType" : 1,
"ip" : [
"192.168.1.0/24"
],
"deviceList" : [
{
"ip" : [
"192.168.1.0/24"
]
}
]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.22.5 Delete a Loopback Interface
Typical Scenarios
A loopback interface needs to be deleted by ID.
Functions
Delete a loopback interface by ID. A loopback interface can be deleted only when
no services reference it.
Constraints
HTTP Method
DELETE
URI

id Yes string 1 to - Loopback "DBB702C3-77

charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/loopbacks/loopback/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.23 L2 and L3 Logical API Management

Logical resource management API:
1. Query sub-resources by resource.
1.9.7.23.1 L2 and L3 Logical API Management
Typical Scenarios
The name and usage of a logical resource need to be queried.
Functions
Query the name and usage of child resources based on the parent resource ID.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/controller/dc/v3/logicnetwork/logicresusage
Request Parameters

er Range Value on

r for
querying
the sub-
resource.
Table 1-1357 queryResDtoWrapper parameters

id Yes string 0 to - Resource ID. "5"

255
charac
ters.
pageIn No int32 0 to - Page index. 5

dex 255
charac
ters.
pageSi No int32 0 to - Page size. 5

ze 255
charac
ters.
order No string 0 to - Order. "desc"

255
charac
ters.
orderV No string 0 to - Order. "logicResource

alue 255 Name"
charac
ters.
Sample Request
HTTP

iMaster NCE-Fabric
POST /controller/dc/v3/logicnetwork/logicresusage HTTP/1.1

Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "5",
"pageIndex" : 5,
"pageSize" : 5,
"order" : "desc",
"orderValue" : "logicResourceName"
}
Response Parameters
Table 1-1358 LogicResourceUsageDtoWrapper parameters

eter t Value
resInfo ARRAY For details, see Table "" -

es _REFER 1-1359.
ENCE
totalN int32 - - ResourceTotalN -

um um
Table 1-1359 LogicResourceUsageDto parameters

eter t Value
service string - - LogicResource -

Parent name
Name
service string - - ResourceId -

ParentI
d
usedN int32 - - ResourceUsage -

um Num

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24 OSPF Process Management

OSPF process APIs:
1. Add, delete, modify, and query OSPF processes.
2. For a group of devices that function as a logic router or external gateway, only
one OSPF or OSPFv3 process can be deployed, with the same process ID. Different
processes can be deployed on different groups of devices. The process IDs that the
Agile Controller-DCN automatically allocates are different by default.
1.9.7.24.1 Create an OSPF Process
Typical Scenarios
An OSPF process needs to be created.
Functions
Create an OSPF process globally or in a tenant view. By default, an OSPF process
created in a tenant view is visible to the tenant.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/ospf/processs

iMaster NCE-Fabric
Request Parameters

er Range Value on

r model
class for
creating
an OSPF
process.
Table 1-1361 OspfProcessDtoWrapper parameters

proces Yes ARRAY For details, see "" -

ENCE
Table 1-1362 OspfProcessDto parameters


ters. 65309"
name Yes string 1 to - OSPF process "ospf1"

255 name, which
charac can be
ters. updated.

charac be updated.
ters.

iMaster NCE-Fabric

owner Yes int32 [1-2] - OSPF process 1

Type owner. 1:
Logical router.
2: External
gateway. This
parameter
cannot be
updated.
routerI Yes string 0 to - Associated "DBB702C3-77

d 256 logicRouterId 19-4FE6-
charac or external A5AD-3A9C9E2
ters. gateway's 65309"
LogicRouterId,
which cannot
be updated.
type Yes int32 [1-2] - OSPF process 1

type. 1: Static.
2: Dynamic.
This parameter
cannot be
updated.
ospfPr No int64 [1-429 - ID of the OSPF 100

ocessId 49672 or OSPFv3
95] process on the
forwarding
plane. This
parameter is
optional. If this
parameter is
not specified, a
process ID will
be
automatically
applied for
from the
resource pool.
device No ARRAY For details, see Device group -

Group _REFER Table 1-1363. where the
ENCE OSPF process is
deployed. This
parameter is
mandatory for
static OSPF
processes.

iMaster NCE-Fabric

ospfCf No REFER For details, see "" -

g ENCE Table 1-1365.
ospfV3 No REFER For details, see "" -

Cfg ENCE Table 1-1365.
Table 1-1363 OspfDeviceGroupDto parameters


Group 256 where the 19-4FE6-
charac OSPF process is A5AD-3A9C9E2
ters. deployed. 65309"
device No ARRAY For details, see Device -

Cfg _REFER Table 1-1364. configuration.
ENCE
Table 1-1364 DeviceCfgDto parameters


d 256 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
ospfRo No string 0 to - OSPF/OSPFv3 "192.168.1.1"

uterId 255 router ID. This
charac parameter is
ters. mandatory for
static OSPF
processes. For
a dynamic
OSPF process,
the controller
automatically
applies for a
router ID from
the resource
pool for each
logical router
and device.

iMaster NCE-Fabric
Table 1-1365 ProcessDto parameters

vpnCa No boolea - false Whether false

pabilit n routing loop
y detection is
disabled and
routes are
calculated
directly.
bandw No int32 [1-214 100 Bandwidth 100

idthRef 74836 reference value
erence 47] for link cost
calculation.
routeP No ARRAY For details, see OSPF route -

referen _REFER Table 1-1366. priority.
ce ENCE
stubRo No REFER For details, see "" -

uter ENCE Table 1-1367.
default No REFER For details, see "" -

Route ENCE Table 1-1368.
import No ARRAY For details, see Information -

Rtp _REFER Table 1-1369. about
ENCE redistributed
routes that are
learned from
other routing
protocols.
export No string 0 to - Associated "DBB702C3-77

2Evpn 256 router policy 19-4FE6-
RtpId charac ID. A5AD-3A9C9E2
ters. 65309"
filterI No string 0 to - Associated "DBB702C3-77

mport 256 router policy 19-4FE6-
RtpId charac ID. A5AD-3A9C9E2
ters. 65309"
timer No REFER For details, see "" -

ENCE Table 1-1370.

iMaster NCE-Fabric
Table 1-1366 RoutePreferenceDto parameters

routeT No int32 - - 1: Default. 2: 1

ype ASE.
prefere No int32 [1-255 - OSPF route 10

nce ] priority. The
default value is
10. When the
router type is
ASE, the
default OSPF
route priority is
150.
Table 1-1367 StubRouterDto parameters

flag No string ● NoC NoConf Stub device "NoConfig"

onfi ig flag.
g
● Stu
bOn
Han
d
● Stu
bOn
Boo
t
interva No int32 [5-655 500 Interval for 500

l 35] keeping the
device as a
stub device
when the
device is
restarted or
faulty, in
seconds.

iMaster NCE-Fabric

extern No boolea - false Whether true

alLsa n external-LSAs
with the
default
overriding
metric are
advertised.
extern No int32 [1-167 167116 User-defined 16711680

alCost 77215] 80 overriding
metric.
Table 1-1368 DefaultRouteDto parameters

enable No boolea - false Whether the true

n default route is
advertised to a
common OSPF
area.
always No boolea - false Whether an true

n LSA that
describes a
default route is
generated and
advertised
regardless of
whether there
are active
default routes
of other OSPF
processes in
the routing
table of the
local device.
permit No boolea - false Whether IBGP true

-ibgp n routes are
imported.

iMaster NCE-Fabric
Table 1-1369 ImportRouteDto parameters

protoc No int32 - - Protocol from 1

ol which routes
are imported.
1: Direct. 2:
Static. 3: BGP.
cost No int32 [0-167 - Route cost. 1

77214]
tag No int64 [0-429 - Tag of an 1

49672 external LSA.
95]
type No int32 - - Type of 1

external routes.
1: Type 1. 2:
Type 2.
permitI No boolea - false Whether IBGP true

bgp n routes can be
imported.
rtpId No string 0 to - Associated "DBB702C3-77

256 router policy 19-4FE6-
charac ID. A5AD-3A9C9E2
ters. 65309"
Table 1-1370 TimerDto parameters

lsaArri No REFER For details, see "" -

val ENCE Table 1-1371.
lsaOrig No REFER For details, see "" -

inate ENCE Table 1-1372.
spfSch No REFER For details, see "" -

edule ENCE Table 1-1373.

iMaster NCE-Fabric
Table 1-1371 LsaArrivalDto parameters

interva No boolea - false Whether the false

lEnabl n interval for
e receiving OSPF
LSAs is set.
interva No int32 [0-100 - Interval for 1

l 00] receiving LSAs,
in milliseconds.
intellig No boolea - false Whether an false

entTim n intelligent
erEnab timer is
le enabled to
specify the
interval for
receiving LSAs.
maxInt No int32 [1-300 1000 Maximum 1000

erval 000] interval for
receiving OSPF
LSAs, in
milliseconds.
startInt No int32 [0-600 500 Initial interval 500

erval 00] for receiving
OSPF LSAs, in
milliseconds.
holdInt No int32 [0-600 500 Hold interval 500

erval 00] for receiving
OSPF LSAs, in
milliseconds.
Table 1-1372 LsaOriginateDto parameters


erEnab timer is
le enabled to
specify the
interval for
updating OSPF
LSAs.

iMaster NCE-Fabric


updating OSPF
LSAs, in
milliseconds.

erval 00] for updating
OSPF LSAs, in
milliseconds.

erval 00] for updating
OSPF LSAs, in
milliseconds.
Table 1-1373 SpfScheduleDto parameters


erEnab timer is
le enabled to
specify the
interval for
calculating the
SPF.

calculating the
SPF, in
milliseconds.

erval 00] for calculating
the SPF, in
milliseconds.

erval 00] for calculating
the SPF, in
milliseconds.

iMaster NCE-Fabric
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/ospf/processs HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"process" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "ospf1",
"ownerType" : 1,
"type" : 1,
"ospfProcessId" : 100,
"deviceGroup" : [
{
"deviceGroup" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"deviceCfg" : [
{
"ospfRouterId" : "192.168.1.1"
}
]
}
],
"ospfCfg" : {
"vpnCapability" : false,
"bandwidthReference" : 100,
"routePreference" : [
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"flag" : "NoConfig",
"interval" : 500,
"externalLsa" : true,
"externalCost" : 16711680
},
"defaultRoute" : {
"enable" : true,
"always" : true,
"permit-ibgp" : true
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
"permitIbgp" : true,
"rtpId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309"
}
],
"export2EvpnRtpId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"filterImportRtpId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"timer" : {
"lsaArrival" : {
"intervalEnable" : false,
"interval" : 1,
"intelligentTimerEnable" : false,

iMaster NCE-Fabric
"maxInterval" : 1000,
"startInterval" : 500,
"holdInterval" : 500
},
"lsaOriginate" : {
},
"spfSchedule" : {
}
}
},
"ospfV3Cfg" : {
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,
},
"defaultRoute" : {
"enable" : true,
"always" : true,
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},
"spfSchedule" : {

iMaster NCE-Fabric
}
}
}
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.2 Query the OSPF Process List
Typical Scenarios
OSPF process information needs to be queried.
Functions
Query the OSPF process list by logical router or external gateway.
Constraints
HTTP Method
GET

iMaster NCE-Fabric
URI
/controller/dc/v3/logicnetwork/ospf/processs


dex 255
charac
ters.

ze 255
charac
ters.
vrfNa No string - - VRF name, "vrfName1"

me used as a
query
condition.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/ospf/processs?pageIndex=1&pageSize=1&vrfName=vrfName1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1375 OspfProcessPagedDtoWrapper parameters

eter t Value
proces ARRAY For details, see Table "" -

s _REFER 1-1376.
ENCE

iMaster NCE-Fabric

eter t Value

um ] of queried
OSPF
processes.

dex

ze
Table 1-1376 OspfProcessDto parameters

eter t Value

65309"
name string 1 to 255 - OSPF process "ospf1"

characters. name, which
can be
updated.

be updated.
owner int32 [1-2] - OSPF process 1

Type owner. 1:
Logical router.
2: External
gateway. This
parameter
cannot be
updated.
routerI string 0 to 256 - Associated "DBB702C3-77

d characters. logicRouterId 19-4FE6-
or external A5AD-3A9C9E2
gateway's 65309"
LogicRouterId,
which cannot
be updated.

iMaster NCE-Fabric

eter t Value
type int32 [1-2] - OSPF process 1

type. 1: Static.
2: Dynamic.
This parameter
cannot be
updated.
ospfPr int64 [1-4294967295 - ID of the OSPF 100

ocessId ] or OSPFv3
process on the
forwarding
plane. This
parameter is
optional. If this
parameter is
not specified, a
process ID will
be
automatically
applied for
from the
resource pool.

Group _REFER 1-1377. where the
ENCE OSPF process is
deployed. This
parameter is
mandatory for
static OSPF
processes.
ospfCf REFER For details, see Table "" -

g ENCE 1-1379.
ospfV3 REFER For details, see Table "" -

Cfg ENCE 1-1379.
Table 1-1377 OspfDeviceGroupDto parameters

eter t Value

Group characters. where the 19-4FE6-
OSPF process is A5AD-3A9C9E2
deployed. 65309"

iMaster NCE-Fabric

eter t Value
device ARRAY For details, see Table Device -

Cfg _REFER 1-1378. configuration.
ENCE
Table 1-1378 DeviceCfgDto parameters

eter t Value

A5AD-3A9C9E2
65309"
ospfRo string 0 to 255 - OSPF/OSPFv3 "192.168.1.1"

uterId characters. router ID. This
parameter is
mandatory for
static OSPF
processes. For
a dynamic
OSPF process,
the controller
automatically
applies for a
router ID from
the resource
pool for each
logical router
and device.
Table 1-1379 ProcessDto parameters

eter t Value
vpnCa boolea - false Whether false

pabilit n routing loop
y detection is
disabled and
routes are
calculated
directly.

iMaster NCE-Fabric

eter t Value
bandw int32 [1-2147483647 100 Bandwidth 100

idthRef ] reference value
erence for link cost
calculation.
routeP ARRAY For details, see Table OSPF route -

referen _REFER 1-1380. priority.
ce ENCE
stubRo REFER For details, see Table "" -

uter ENCE 1-1381.
default REFER For details, see Table "" -

Route ENCE 1-1382.
import ARRAY For details, see Table Information -

Rtp _REFER 1-1383. about
ENCE redistributed
routes that are
learned from
other routing
protocols.
export string 0 to 256 - Associated "DBB702C3-77

2Evpn characters. router policy 19-4FE6-
RtpId ID. A5AD-3A9C9E2
65309"
filterI string 0 to 256 - Associated "DBB702C3-77

mport characters. router policy 19-4FE6-
RtpId ID. A5AD-3A9C9E2
65309"
timer REFER For details, see Table "" -

ENCE 1-1384.
Table 1-1380 RoutePreferenceDto parameters

eter t Value
routeT int32 - - 1: Default. 2: 1

ype ASE.

iMaster NCE-Fabric

eter t Value
prefere int32 [1-255] - OSPF route 10

nce priority. The
default value is
10. When the
router type is
ASE, the
default OSPF
route priority is
150.
Table 1-1381 StubRouterDto parameters

eter t Value
flag string ● NoConfig NoConf Stub device "NoConfig"

ig flag.
● StubOnHand
● StubOnBoot
interva int32 [5-65535] 500 Interval for 500

l keeping the
device as a
stub device
when the
device is
restarted or
faulty, in
seconds.
extern boolea - false Whether true

alLsa n external-LSAs
with the
default
overriding
metric are
advertised.
extern int32 [1-16777215] 167116 User-defined 16711680

alCost 80 overriding
metric.

iMaster NCE-Fabric
Table 1-1382 DefaultRouteDto parameters

eter t Value
enable boolea - false Whether the true

n default route is
advertised to a
common OSPF
area.
always boolea - false Whether an true

n LSA that
describes a
default route is
generated and
advertised
regardless of
whether there
are active
default routes
of other OSPF
processes in
the routing
table of the
local device.
permit boolea - false Whether IBGP true

-ibgp n routes are
imported.
Table 1-1383 ImportRouteDto parameters

eter t Value
protoc int32 - - Protocol from 1

ol which routes
are imported.
1: Direct. 2:
Static. 3: BGP.
cost int32 [0-16777214] - Route cost. 1
tag int64 [0-4294967295 - Tag of an 1

] external LSA.
type int32 - - Type of 1

external routes.
1: Type 1. 2:
Type 2.

iMaster NCE-Fabric

eter t Value
permitI boolea - false Whether IBGP true

bgp n routes can be
imported.
rtpId string 0 to 256 - Associated "DBB702C3-77

characters. router policy 19-4FE6-
ID. A5AD-3A9C9E2
65309"
Table 1-1384 TimerDto parameters

eter t Value
lsaArri REFER For details, see Table "" -

val ENCE 1-1385.
lsaOrig REFER For details, see Table "" -

inate ENCE 1-1386.
spfSch REFER For details, see Table "" -

edule ENCE 1-1387.
Table 1-1385 LsaArrivalDto parameters

eter t Value
interva boolea - false Whether the false

lEnabl n interval for
e receiving OSPF
LSAs is set.
interva int32 [0-10000] - Interval for 1

l receiving LSAs,
in milliseconds.
intellig boolea - false Whether an false

erEnab timer is
le enabled to
specify the
interval for
receiving LSAs.

iMaster NCE-Fabric

eter t Value
maxInt int32 [1-300000] 1000 Maximum 1000

erval interval for
receiving OSPF
LSAs, in
milliseconds.
startInt int32 [0-60000] 500 Initial interval 500

erval for receiving
OSPF LSAs, in
milliseconds.
holdInt int32 [0-60000] 500 Hold interval 500

erval for receiving
OSPF LSAs, in
milliseconds.
Table 1-1386 LsaOriginateDto parameters

eter t Value

erEnab timer is
le enabled to
specify the
interval for
updating OSPF
LSAs.

erval interval for
updating OSPF
LSAs, in
milliseconds.

erval for updating
OSPF LSAs, in
milliseconds.

erval for updating
OSPF LSAs, in
milliseconds.

iMaster NCE-Fabric
Table 1-1387 SpfScheduleDto parameters

eter t Value

erEnab timer is
le enabled to
specify the
interval for
calculating the
SPF.

erval interval for
calculating the
SPF, in
milliseconds.

erval for calculating
the SPF, in
milliseconds.

erval for calculating
the SPF, in
milliseconds.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"process" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "ospf1",
"ownerType" : 1,
"type" : 1,
"deviceGroup" : [

iMaster NCE-Fabric
{
"deviceCfg" : [
{
}
]
}
],
"ospfCfg" : {
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,
},
"defaultRoute" : {
"enable" : true,
"always" : true,
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},
"spfSchedule" : {
}
}
},
"ospfV3Cfg" : {

iMaster NCE-Fabric
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,
},
"defaultRoute" : {
"enable" : true,
"always" : true,
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},
"spfSchedule" : {
}
}
}
}
],
"totalNum" : 200,
"pageIndex" : 10,
"pageSize" : 10
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
1.9.7.24.3 Query OSPF Process Information
Typical Scenarios
OSPF process information needs to be queried.
Functions
Query OSPF process information.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/ospf/processs/process/{id}


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/ospf/processs/process/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric
Table 1-1389 OspfProcessDtoWrapper parameters

eter t Value
proces ARRAY For details, see Table "" -

s _REFER 1-1376.
ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"process" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "ospf1",
"ownerType" : 1,
"type" : 1,
"deviceGroup" : [
{
"deviceCfg" : [
{
}
]
}
],
"ospfCfg" : {
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,
},
"defaultRoute" : {
"enable" : true,
"always" : true,

iMaster NCE-Fabric
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},
"spfSchedule" : {
}
}
},
"ospfV3Cfg" : {
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,
},
"defaultRoute" : {
"enable" : true,
"always" : true,
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],

iMaster NCE-Fabric
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},
"spfSchedule" : {
}
}
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.4 Update OSPF Process Information
Typical Scenarios
OSPF process information needs to be updated.
Functions
Update OSPF process information by ID. An OSPF process can be updated only
when no services reference it.
Constraints
HTTP Method
PUT
URI

iMaster NCE-Fabric

id Yes string 0 to - ID of the OSPF "DBB702C3-77

256 process to be 19-4FE6-
ters. 65309"
Request Parameters

er Range Value on

r model
class for
updating
an OSPF
process.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/ospf/processs/process/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"process" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "ospf1",
"ownerType" : 1,
"type" : 1,
"deviceGroup" : [
{
"deviceCfg" : [
{
}
]

iMaster NCE-Fabric
}
],
"ospfCfg" : {
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,
},
"defaultRoute" : {
"enable" : true,
"always" : true,
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},
"spfSchedule" : {
}
}
},
"ospfV3Cfg" : {
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,

iMaster NCE-Fabric
},
"defaultRoute" : {
"enable" : true,
"always" : true,
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},
"spfSchedule" : {
}
}
}
}
]
}
Response Parameters
OspfProcessDtoWrapper parameters, For details, see Table 1-1389.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric
{
"process" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "ospf1",
"ownerType" : 1,
"type" : 1,
"deviceGroup" : [
{
"deviceCfg" : [
{
}
]
}
],
"ospfCfg" : {
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,
},
"defaultRoute" : {
"enable" : true,
"always" : true,
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},

iMaster NCE-Fabric
"spfSchedule" : {
}
}
},
"ospfV3Cfg" : {
{
"routeType" : 1,
"preference" : 10
}
],
"stubRouter" : {
"interval" : 500,
},
"defaultRoute" : {
"enable" : true,
"always" : true,
},
"importRtp" : [
{
"protocol" : 1,
"cost" : 1,
"tag" : 1,
"type" : 1,
}
],
"timer" : {
"lsaArrival" : {
"interval" : 1,
},
"lsaOriginate" : {
},
"spfSchedule" : {
}
}
}
}
]
}

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.5 Delete OSPF Process Information
Typical Scenarios
An OSPF process needs to be deleted by ID.
Functions
Delete an OSPF process by ID. An OSPF process can be deleted only when no
services reference it.
Constraints
HTTP Method
DELETE
URI

id Yes string 0 to - OSPF process "DBB702C3-77

256 ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/ospf/processs/process/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.6 Create an OSPF Neighbor
Typical Scenarios
An OSPF neighbor needs to be created.
Functions
Create an OSPF neighbor globally or in a tenant view. By default, an OSPF
neighbor created in a tenant view is visible to the tenant.
Constraints
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/ospf/peers

iMaster NCE-Fabric
Request Parameters

er Range Value on

r model
class for
creating
an OSPF
neighbor.
Table 1-1394 OspfPeerDtoWrapper parameters

peer Yes ARRAY For details, see "" -

_REFER Table 1-1395.
ENCE

id Yes string 0 to - OSPF neighbor "DBB702C3-77

256 ID, which 19-4FE6-
proces Yes string 0 to - OSPF network "DBB702C3-77

sId 256 process ID, 19-4FE6-
charac which cannot A5AD-3A9C9E2
ters. be updated. 65309"
ipFami Yes int32 [1-2] - 1: IPv4 OSPF 1

ly neighbor. 2:
IPv6 OSPFv3
neighbor.

iMaster NCE-Fabric

sourceI Yes int32 - - OSPF source 1

fType interface type.
1: Gateway. 2:
Loopback
interface. 3.
Interconnection
interface. This
parameter
cannot be
updated.
sourceI Yes string 0 to - OSPF session "DBB702C3-77

fId 256 source 19-4FE6-
charac interface, A5AD-3A9C9E2
ters. which is a 65309"
logical switch
ID,
interconnection
interface ID, or
loopback
interface ID.
This parameter
cannot be
updated.
areaId Yes string 0 to - OSPF area ID. "192.168.2.2"

255 The default
charac value is 0.0.0.0.
ters.
networ Yes int32 - - Network type. 1

kType 1: Broadcast. 2:
P2P.
drPrior No int32 [0-255 1 Priority of the 100

ity ] interface that
participates in
the DR and
BDR election.
cost No int32 [1-655 - To set the cost 100

35] of an interface.
helloIn No int32 [1-655 - Interval for 100

terval 35] sending Hello
packets on an
interface, in
seconds.

iMaster NCE-Fabric

deadIn No int32 [1-235 - Dead interval 100

terval 92600 of an OSPF
0] neighbor, in
seconds.
bfd No REFER For details, see "" -

ENCE Table 1-1396.
auth No REFER For details, see "" -

ENCE Table 1-1397.
Table 1-1396 BfdDto parameters

enable Yes boolea - false Whether to false

n enable
dynamic BFD.
detect No int32 [3-50] 3 Detection 3

Multipl multiplier. The
ier default value is
3. This
parameter can
be updated.
minTxi No int32 [3-200 10 Minimum 10

nterval 00] transmit
interval, in
milliseconds.
The default
value is 10.
This parameter
can be
updated.
minRxi No int32 [3-200 10 Minimum 10

nterval 00] receive interval,
in milliseconds.
The default
value is 10.
This parameter
can be
updated.

iMaster NCE-Fabric
Table 1-1397 IfAuthDto parameters

mode Yes int32 - - Authentication 1

mode. 1: None.
2: Simple. 3:
HMAC-
SHA256.
passw No string 1 to - This field may "passwordText"

ordTex 255 contain
t charac sensitive or
Keep it secure.
Password
character
string.
keyId No int32 [0-255 - Authentication 1

] key ID of the
interface's
cipher
authentication.
The key ID
must be
consistent with
that of the
peer.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/ospf/peers HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"peer" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"processId" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"ipFamily" : 1,
"sourceIfType" : 1,
"areaId" : "192.168.2.2",
"networkType" : 1,
"drPriority" : 100,
"cost" : 100,
"helloInterval" : 100,
"deadInterval" : 100,
"bfd" : {

iMaster NCE-Fabric
"enable" : false,
"minTxinterval" : 10,
"minRxinterval" : 10
},
"auth" : {
"mode" : 1,
"passwordText" : "passwordText",
"keyId" : 1
}
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.7 Query the OSPF Neighbor List
Typical Scenarios
OSPF neighbor information needs to be queried.
Functions
Query the OSPF neighbor list by the OSPF network process ID, VRF name,
interface name, or IP address family.
Constraints

iMaster NCE-Fabric
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/ospf/peers


dex 255
charac
ters.

ze 255
charac
ters.
proces No string 0 to - OSPF process -

sId 256 ID, which can
charac be used as a
ters. query
condition.
ospfPr No int64 [1-429 - ID of an OSPF -

ocessId 49672 process on the
95] forwarding
plane, which
can be used as
a query
condition.
vrfNa No string 0 to 36 - VRF name, "vrfName1"

me charac which can be
ters. used as a
query
condition.
ifNam No string 0 to - Interface "ifName1"

e 255 name, which
charac can be used as
ters. a query
condition with
a VRF name.

iMaster NCE-Fabric

ipFami No int32 [1-2] - IP address -

ly family, which
can be used as
a query
condition with
a process ID.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/ospf/peers?
pageIndex=1&pageSize=1&vrfName=vrfName1&ifName=ifName1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1399 OspfPeerPagedDtoWrapper parameters

eter t Value
peer ARRAY For details, see Table "" -

_REFER 1-1400.
ENCE

um ] of queried
OSPF
processes.

dex

ze

iMaster NCE-Fabric

eter t Value
id string 0 to 256 - OSPF neighbor "DBB702C3-77

characters. ID, which 19-4FE6-
updated. 65309"
proces string 0 to 256 - OSPF network "DBB702C3-77

sId characters. process ID, 19-4FE6-
be updated. 65309"
ipFami int32 [1-2] - 1: IPv4 OSPF 1

ly neighbor. 2:
IPv6 OSPFv3
neighbor.
sourceI int32 - - OSPF source 1

fType interface type.
1: Gateway. 2:
Loopback
interface. 3.
Interconnection
interface. This
parameter
cannot be
updated.
sourceI string 0 to 256 - OSPF session "DBB702C3-77

fId characters. source 19-4FE6-
interface, A5AD-3A9C9E2
which is a 65309"
logical switch
ID,
interconnection
interface ID, or
loopback
interface ID.
This parameter
cannot be
updated.
areaId string 0 to 255 - OSPF area ID. "192.168.2.2"

characters. The default
value is 0.0.0.0.
networ int32 - - Network type. 1

kType 1: Broadcast. 2:
P2P.

iMaster NCE-Fabric

eter t Value
drPrior int32 [0-255] 1 Priority of the 100

ity interface that
participates in
the DR and
BDR election.
cost int32 [1-65535] - To set the cost 100

of an interface.
helloIn int32 [1-65535] - Interval for 100

terval sending Hello
packets on an
interface, in
seconds.
deadIn int32 [1-235926000] - Dead interval 100

terval of an OSPF
neighbor, in
seconds.
bfd REFER For details, see Table "" -

ENCE 1-1401.
auth REFER For details, see Table "" -

ENCE 1-1402.
Table 1-1401 BfdDto parameters

eter t Value
enable boolea - false Whether to false

n enable
dynamic BFD.
detect int32 [3-50] 3 Detection 3

Multipl multiplier. The
ier default value is
3. This
parameter can
be updated.

iMaster NCE-Fabric

eter t Value
minTxi int32 [3-20000] 10 Minimum 10

nterval transmit
interval, in
milliseconds.
The default
value is 10.
This parameter
can be
updated.
minRxi int32 [3-20000] 10 Minimum 10

nterval receive interval,
in milliseconds.
The default
value is 10.
This parameter
can be
updated.
Table 1-1402 IfAuthDto parameters

eter t Value
mode int32 - - Authentication 1

mode. 1: None.
2: Simple. 3:
HMAC-
SHA256.
passw string 1 to 255 - This field may "passwordText"

ordTex characters. contain
t sensitive or
personal data.
Keep it secure.
Password
character
string.

iMaster NCE-Fabric

eter t Value
keyId int32 [0-255] - Authentication 1

key ID of the
interface's
cipher
authentication.
The key ID
must be
consistent with
that of the
peer.
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"peer" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"ipFamily" : 1,
"sourceIfType" : 1,
"areaId" : "192.168.2.2",
"networkType" : 1,
"drPriority" : 100,
"cost" : 100,
"bfd" : {
"enable" : false,
},
"auth" : {
"mode" : 1,
"keyId" : 1
}
}
],
"totalNum" : 200,
"pageIndex" : 10,
"pageSize" : 10
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.8 Query OSPF Neighbor Information
Typical Scenarios
OSPF neighbor information needs to be queried.
Functions
Query OSPF neighbor information.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/ospf/peers/peer/{id}


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/ospf/peers/peer/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002

iMaster NCE-Fabric
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1404 OspfPeerDtoWrapper parameters

eter t Value
peer ARRAY For details, see Table "" -

_REFER 1-1400.
ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"peer" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"ipFamily" : 1,
"sourceIfType" : 1,
"areaId" : "192.168.2.2",
"networkType" : 1,
"drPriority" : 100,
"cost" : 100,
"bfd" : {
"enable" : false,
},
"auth" : {
"mode" : 1,
"keyId" : 1
}
}
]
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.9 Update OSPF Neighbor Information
Typical Scenarios
OSPF neighbor information needs to be updated.
Functions
Update OSPF neighbor information by ID. An OSPF neighbor can be updated only
when no services reference it.
Constraints
HTTP Method
PUT
URI

id Yes string 0 to - ID of the OSPF "DBB702C3-77

256 neighbor to be 19-4FE6-
ters. 65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

r model
class for
updating
an OSPF
neighbor.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/ospf/peers/peer/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"peer" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"ipFamily" : 1,
"sourceIfType" : 1,
"areaId" : "192.168.2.2",
"networkType" : 1,
"drPriority" : 100,
"cost" : 100,
"bfd" : {
"enable" : false,
},
"auth" : {
"mode" : 1,
"keyId" : 1
}
}
]
}
Response Parameters
OspfPeerDtoWrapper parameters, For details, see Table 1-1404.

iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"peer" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"ipFamily" : 1,
"sourceIfType" : 1,
"areaId" : "192.168.2.2",
"networkType" : 1,
"drPriority" : 100,
"cost" : 100,
"bfd" : {
"enable" : false,
},
"auth" : {
"mode" : 1,
"keyId" : 1
}
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.10 Delete OSPF Neighbor Information
Typical Scenarios
An OSPF neighbor needs to be deleted by ID.
Functions
Delete an OSPF neighbor by ID. An OSPF neighbor can be deleted only when no
services reference it.

iMaster NCE-Fabric
Constraints
HTTP Method
DELETE
URI

id Yes string 0 to - OSPF neighbor "DBB702C3-77

256 ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
DELETE /controller/dc/v3/logicnetwork/ospf/peers/peer/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT

iMaster NCE-Fabric
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.24.11 Query OSPF Neighbor States
Typical Scenarios
OSPF neighbor states need to be queried.
Functions
Query OSPF neighbor states on a device. If a logical switch is used as a neighbor
interface, the logical switch may be connected to multiple devices. In this case, the
interface will return the neighbor states of multiple devices simultaneously.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/ospf/peers/peer/{id}/running


256 query. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A

iMaster NCE-Fabric
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/ospf/peers/peer/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/running
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Table 1-1409 OspfPeerRunningDtoWrapper parameters

eter t Value
runnin ARRAY For details, see Table OSPF neighbor -

g _REFER 1-1410. states list.
ENCE
Table 1-1410 DevicePeerRunningDto parameters

eter t Value

A5AD-3A9C9E2
65309"
status string 0 to 255 - Neighbor "1"

characters. status. 0:
Down. 1: Init.
2: Attempt. 3:
2-Way. 4:
ExStart. 5:
Exchange. 6:
Loading. 7:
Full.
peerIp string 0 to 255 - Peer IP "1"


iMaster NCE-Fabric
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"running" : [
{
"status" : "1",
"peerIp" : "1"
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25 VPC Routing Whitelist

Routing whitelist API description:
1. Create a routing whitelist.
2. Query routing whitelist information by ID.
3. Update routing whitelist information by ID.
4. Delete routing whitelist information by ID.
SLAs for query interfaces
Throughput: 200 TPS
1.9.7.25.1 Query Routing Whitelist Information by Router ID
Typical Scenarios
Routing whitelist information needs to be queried by router ID.

iMaster NCE-Fabric
Functions
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/external_whitelists/{id}

id Yes UUID 0 to - Routing "DBB702C3-77

255 whitelist ID. 19-4FE6-
charac A5AD-3A9C9E2
ters. 65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/external_whitelists/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters

iMaster NCE-Fabric

eter t Value
extern REFER For details, see Table Whitelist -

al_whit ENCE 1-1413. parameter.
elist

eter t Value
id uuid - - uuid "00000000-000

0-0000-1234-0
00000000002"
router_ uuid - - uuid "00000000-000

id 0-0000-1234-0
00000000002"
routes array< 0-500 items. - Route IP ["192.168.1.0/2

string> Each item has 0 address. 4"]
to 50
characters.
subnet array< 0-500 items. - Subnet ID. ["00000000-00

s string> Each item has 0 00-0000-1234-
to 36 000000000003
characters. "]
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}

iMaster NCE-Fabric
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25.2 Update Routes in the Whitelist
Typical Scenarios
A routing whitelist needs to be queried.
Functions
Query a routing whitelist.
Constraints
HTTP Method
PUT
URI

id Yes UUID 1 to 36 - ID used for the "DBB702C3-77

ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric
Request Parameters

WhiteL Yes REFER For details, see Routing policy -

istDto ENCE Table 1-1416. entity to be
Wrapp updated.
er

extern Yes REFER For details, see Whitelist -

al_whit ENCE Table 1-1417. parameter.
elist

id No uuid - - uuid "00000000-000

0-0000-1234-0
00000000002"
router_ Yes uuid - - uuid "00000000-000

id 0-0000-1234-0
00000000002"
routes Yes array< 0-500 - Route IP ["192.168.1.0/2

string> items. address. 4"]
Each
item
has 0
to 50
charac
ters.

iMaster NCE-Fabric

subnet Yes array< 0-500 - Subnet ID. ["00000000-00

s string> items. 00-0000-1234-
Each 000000000003
item "]
has 0
to 36
charac
ters.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/external_whitelists/DBB702C3-7719-4FE6-A5AD-3A9C9E265309 HTTP/
1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Response Parameters
RouteWhiteListWrapper parameters, For details, see Table 1-1412.
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],

iMaster NCE-Fabric
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25.3 Delete routing whitelist information by routing whitelist ID.
Typical Scenarios
Delete Routes in the Whitelist.
Functions
Delete routing whitelist information by routing whitelist ID.
Constraints
HTTP Method
DELETE
URI

id Yes UUID 1 to 36 - Routing "DBB702C3-77

ters. A5AD-3A9C9E2
65309"
Request Parameters
N/A
Sample Request
HTTP

iMaster NCE-Fabric
DELETE /controller/dc/v3/logicnetwork/external_whitelists/DBB702C3-7719-4FE6-A5AD-3A9C9E265309
HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25.4 Create a Routing Whitelist
Typical Scenarios
A routing whitelist needs to be created.
Functions
Create a routing whitelist.
Constraints
HTTP Method
POST

iMaster NCE-Fabric
URI
/controller/dc/v3/logicnetwork/external_whitelists
Request Parameters

route Yes REFER For details, see Parameters for -

WhiteL ENCE Table 1-1416. creating a
istWra subnet.
pper
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/external_whitelists HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25.5 Query Routing Whitelist Information by Condition
Typical Scenarios
Routing whitelists need to be queried.
Functions
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/external_whitelists

router_ No UUID 1 to 36 - Router ID. "DBB702C3-77

id charac 19-4FE6-
ters. A5AD-3A9C9E2
65309"
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/external_whitelists?router_id=DBB702C3-7719-4FE6-
A5AD-3A9C9E265309 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-1421 RouteWhiteListsWrapper parameters

eter t Value
extern ARRAY 0-255 items. For details, Whitelist -

al_whit _REFER see Table 1-1413. parameter.
elists ENCE
Sample Response
HTTP/1.1 200 OK
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"external_whitelists" : [
{
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
]
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25.6 Add Subnets to a Whitelist
Typical Scenarios
Add Subnets to a Whitelist.

iMaster NCE-Fabric
Functions
Add subnets to a whitelist by subnet ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/external_whitelists/{id}/add_subnets


ters. A5AD-3A9C9E2
65309"
Request Parameters

er Range Value on

r model
class for
adding
subnets
to a
whitelist.

iMaster NCE-Fabric
Table 1-1424 SubnetIdsDtoWrapper parameters

extern Yes REFER For details, see - -

al_whit ENCE Table 1-1425.
elist
Table 1-1425 external_whitelist parameters

subnet Yes array< 0-500 - Subnet ID. ["00000000-00

s string> items. 00-0000-1234-
Each 000000000003
item "]
has 0
to 36
charac
ters.
Sample Request
HTTP
PUT /controller/dc/v3/logicnetwork/external_whitelists/DBB702C3-7719-4FE6-A5AD-3A9C9E265309/
add_subnets HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Response Parameters
Sample Response

iMaster NCE-Fabric

Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25.7 Delete subnets from a whitelist by subnet ID.
Typical Scenarios
Remove Subnets from a Whitelist.
Functions
Delete subnets from a whitelist by subnet ID.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/external_whitelists/{id}/remove_subnets


ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on

r model
class for
deleting
subnets
from a
whitelist.
Sample Request
HTTP
remove_subnets HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-0000-1234-000000000002",

iMaster NCE-Fabric
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25.8 Add routes to a whitelist by route ID.
Typical Scenarios
Add routes to a whitelist by route ID.
Functions
Add routes to a whitelist by route.
Constraints
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/external_whitelists/{id}/add_routes


ters. A5AD-3A9C9E2
65309"

iMaster NCE-Fabric
Request Parameters

er Range Value on
input REFERE For details, see Table Model -

NCE 1-1430. class for
adding
routes to
a
whitelist.

extern Yes REFER For details, see - -

al_whit ENCE Table 1-1431.
elist
Table 1-1431 external_whitelist parameters

routes Yes array< 0-500 - Route IP ["192.168.1.0/2

string> items. address. 4"]
Each
item
has 0
to 50
charac
ters.
Sample Request
HTTP
add_routes HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{

iMaster NCE-Fabric
"routes" : ["192.168.1.0/24"]
}
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.25.9 Delete Specified Routing Whitelist Information
Typical Scenarios
Delete Specified Routing Whitelist Information.
Functions
Delete specified routing whitelist information by routing whitelist ID.
Constraints

iMaster NCE-Fabric
HTTP Method
PUT
URI
/controller/dc/v3/logicnetwork/external_whitelists/{id}/remove_routes


ters. A5AD-3A9C9E2
65309"
Request Parameters

er Range Value on
input REFERE For details, see Table Model -

NCE 1-1430. class for
deleting
routes
from a
whitelist
Sample Request
HTTP
remove_routes HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"routes" : ["192.168.1.0/24"]
}
}
Response Parameters

iMaster NCE-Fabric
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
{
"id" : "00000000-0000-0000-1234-000000000002",
"router_id" : "00000000-0000-0000-1234-000000000002",
"routes" : ["192.168.1.0/24"],
"subnets" : ["00000000-0000-0000-1234-000000000003"]
}
}
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.26 Routing Policy Management

Routing policy APIs:
1. Add, delete, modify, and query routing policies.
1.9.7.26.1 Create a Routing Policy
Typical Scenarios
A routing policy needs to be created.
Functions
Create a routing policy globally or in a tenant view. By default, a routing policy
created in a tenant view is visible to the tenant.
Constraints

iMaster NCE-Fabric
HTTP Method
POST
URI
/controller/dc/v3/logicnetwork/rtps
Request Parameters

rtp Yes REFER For details, see Input -

ENCE Table 1-1435. parameter
model class for
creating a
routing policy.
Table 1-1435 RtpDtoWrapper parameters

rtp Yes ARRAY For details, see RTP -

ENCE
Table 1-1436 RtpDto parameters


ters. 65309"
name No string 1 to - Name of a "bfd1"

200 routing policy
charac configured on
ters. a forwarding
device, which
cannot be
updated after
being
referenced.

iMaster NCE-Fabric

deploy No string 0 to - Alias of the "bfd1"

Policy 200 routing policy
Name charac configured on
ters. the forwarding
device. The
alias cannot be
changed after
the routing
policy is
referenced.

charac be updated.
ters.
rtpTyp Yes string ● best - Policy type, "general"

e Effo which cannot
rtPa be updated.
th
● nfvi
Exp
ort
● dci
● gen
eral
ipVersi No string 1 to 64 - IP version, "ipv4"

on charac which cannot
ters. be updated.
related No array< Each - Associated ["DBB702C3-7

Extern string> item external 719-4FE6-
alGate has 0 gateway ID. A5AD-3A9C9E2
wayIds to 50 65309"]
charac
ters.
device No array< Each - Device group ["DBB702C3-7

GroupI string> item ID. This 719-4FE6-
ds has 0 parameter is A5AD-3A9C9E2
to 50 valid only 65309"]
charac when the
ters. policy type is
set to common
policy. The
value cannot
be changed.

iMaster NCE-Fabric

device No array< Each - Device group ["deviceGroup

Group string> item name. This Name"]
Names has 0 parameter is
to 50 valid only
charac when the
ters. policy type is
set to common
policy. The
value cannot
be changed.
ipPrefi No array< - - IP prefix. This ["192.168.1.0/2

xes string> parameter is 4"]
valid only
when the
policy type is
set to Telco
Cloud Egress
Routing Policy.
dciRou No ARRAY For details, see DCI policy set. -

tePolic _REFER Table 1-1437. This parameter
y ENCE is valid only
when the
policy type is
DCI.
thirdPa No boolea - false Valid when the false

rtyEna n DCI routing
ble policy is
configured. If
this function is
enabled, the
DCI gateway
advertises
inclusive Type
3 routes
together with
IRB host
routes.
merge No boolea - false Whether to false

n incrementally
update the
node of the
routing policy.

iMaster NCE-Fabric

rtpNod No ARRAY For details, see DCI policy type, -

e _REFER Table 1-1438. which can be
ENCE DciImport,
DciExport, or
DciDyeing. The
value cannot
be changed.

Table 1-1437 DciRoutePolicyDto parameters

id No string 0 to - Object ID. This "DBB702C3-77

ters. 65309"
name Yes string 1 to - Name of a "bfd1"

200 routing policy
charac configured on
ters. a forwarding
device, which
cannot be
updated after
being
referenced.
dciTyp No string 1 to 64 - DCI policy type, "DciImport"

e charac which can be
ters. DciImport,
DciExport, or
DciDyeing. The
value cannot
be changed.
startN No int32 [1-200 101 Start node ID 101

odeId 00] of the export
routing policy
applied by an
L3DCI service.

iMaster NCE-Fabric
Table 1-1438 RtpNodeDto parameters

index Yes int32 [0-655 - Routing policy 1

35] node, which
cannot be
updated.
mode No int32 - - Whether to 1

deliver the
goto next-node
command.
gotoN No boolea - false Whether to false

extNod n deliver the
e goto next-node
command.
match No REFER For details, see Match -

action No REFER For details, see Action -

ENCE Table 1-1444. Information.
Table 1-1439 MatchDto parameters

ipPrefi No ARRAY For details, see IP prefix -

x _REFER Table 1-1440. information.
ENCE
tag No int64 [1-429 - Route tag, 82345

49672 which cannot
95] be updated.
comm No ARRAY For details, see Community -

unity _REFER Table 1-1441. information.
ENCE
extCo No ARRAY For details, see ExtCommunity -

mmuni _REFER Table 1-1442. information.
ty ENCE
asPath No ARRAY For details, see AS_Path -

ENCE

iMaster NCE-Fabric

l2vni No array Item
value
range:
[1-160
00000]
l3vni No array Item
value
range:
[1-160
00000]
routeT No array Item 2: EVPN MAC.
value 3: EVPN prefix.
range:
[1-3]
Table 1-1440 IpPrefixDto parameters

index Yes int64 [1-429 - IP prefix. 10

49672
95]
mode No int32 - 1 Node type. 1: 1

Permit. 2:
Deny. This
parameter
cannot be
updated.
prefix No string 1 to - IP prefix. "10.10.10.0/24"

255
charac
ters.

iMaster NCE-Fabric

match No boolea - false Whether a false

Netwo n network
rk address for
matching is
specified. This
parameter
cannot be
updated.
maskL No int32 [0-128 - Minimum 1

engthL ] subnet mask
ower length for
matching. This
parameter
cannot be
updated.
maskL No int32 [0-128 - Maximum 1

ength ] subnet mask
Upper length for
matching. This
parameter
cannot be
updated.
Table 1-1441 CommunityDto parameters

index Yes int64 [1-429 - Extended 10

49672 community
95] attributes.

Permit. 2:
Deny. This
parameter
cannot be
updated.
value No array

iMaster NCE-Fabric
Table 1-1442 ExtCommunityDto parameters

index Yes int64 [1-429 - SN, which 10

49672 cannot be
95] updated.

Permit. 2:
Deny. This
parameter
cannot be
updated.
rtValue No array< 0-255 - Extended -

string> items. community
attributes.
Table 1-1443 AsPathDto parameters

index Yes int64 [1-429 - SN, which 10

49672 cannot be
95] updated.

Permit. 2:
Deny. This
parameter
cannot be
updated.
regular No string 1 to - AS path "_30_"

Expres 1024 regular
sion charac expression.
ters.
Table 1-1444 ActionDto parameters

applyC No REFER For details, see ApplyCommuni -

ommu ENCE Table 1-1445. ty information.
nity

iMaster NCE-Fabric

applyA No REFER For details, see ApplyAsPath -

sPath ENCE Table 1-1446. information.
applyC No REFER For details, see ApplyCost -

ost ENCE Table 1-1447. information.
applyL No REFER For details, see ApplyLocalpref -

ocalPre ENCE Table 1-1448. erence
ference information.
applyP No REFER For details, see ApplyPreferenc -

referen ENCE Table 1-1449. e information.
ce
applyG No boolea - false Whether to set false

ateway n the router's
Origin next-hop
Nextho address as the
p gateway IP
address for the
EVPN route.
Table 1-1445 ApplyCommunityDto parameters

comm Yes array< 0-4 - Community -

unity string> items. attributes.
Each
item
has 0
to 255
charac
ters.
additiv No boolea - false Whether to false

e n add
community
attributes.

iMaster NCE-Fabric
Table 1-1446 ApplyAsPathDto parameters

operati Yes int32 - 1 1: override 2: 1

on increase 3:
delete special
4: delete all.
asNum No array
Table 1-1447 ApplyCostDto parameters

operati Yes int32 - 1 1: override 2: 1

on increase 3:
delete special
4: delete all.
cost No int64 [0-429 - Protocol 10

49672 priority of a
95] route.
Table 1-1448 ApplyLocalpreferenceDto parameters

value Yes int64 [0-429 - Route cost. 10

49672
95]
Table 1-1449 ApplyPreferenceDto parameters

value Yes int32 [1-255 - Protocol 10

] priority of a
route.

iMaster NCE-Fabric

produc No string 0 to 36 - Producer. This "10"

specified by the
user, the
specified value
is used. The
character string
starting with
component is
reserved. If no
value is
specified, the
default value
default is used.

At 255 0:19:41.000+00:
charac 00"
ters.

At 255 0:19:41.000+00:
charac 00"
ters.
Sample Request
HTTP
POST /controller/dc/v3/logicnetwork/rtps HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-
{
"rtp" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",
"name" : "bfd1",
"deployPolicyName" : "bfd1",
"rtpType" : "general",
"ipVersion" : "ipv4",
"relatedExternalGatewayIds" : ["DBB702C3-7719-4FE6-A5AD-3A9C9E265309"],
"deviceGroupIds" : ["DBB702C3-7719-4FE6-A5AD-3A9C9E265309"],
"deviceGroupNames" : ["deviceGroupName"],
"ipPrefixes" : ["192.168.1.0/24"],
"dciRoutePolicy" : [
{
"id" : "DBB702C3-7719-4FE6-A5AD-3A9C9E265309",

iMaster NCE-Fabric
"name" : "bfd1",
"dciType" : "DciImport",
"startNodeId" : 101
}
],
"thirdPartyEnable" : false,
"merge" : false,
"rtpNode" : [
{
"index" : 1,
"mode" : 1,
"gotoNextNode" : false,
"match" : {
"ipPrefix" : [
{
"index" : 10,
"mode" : 1,
"prefix" : "10.10.10.0/24",
"matchNetwork" : false,
"maskLengthLower" : 1,
"maskLengthUpper" : 1
}
],
"tag" : 82345,
"community" : [
{
"index" : 10,
"mode" : 1,
"value" : [
100
]
}
],
"extCommunity" : [
{
"index" : 10,
"mode" : 1,
"rtValue" : [
"100:1"
]
}
],
"asPath" : [
{
"index" : 10,
"mode" : 1,
"regularExpression" : "_30_"
}
],
"l2vni" : [
"100"
],
"l3vni" : [
"100"
],
"routeType" : [
"1"
]
},
"action" : {
"applyCommunity" : {
"community" : [
"100:1"
],
"additive" : false
},
"applyAsPath" : {
"operation" : 1,
"asNumber" : [

iMaster NCE-Fabric
"10"
]
},
"applyCost" : {
"operation" : 1,
"cost" : 10
},
"applyLocalPreference" : {
"value" : 10
},
"applyPreference" : {
"value" : 10
},
"applyGatewayOriginNexthop" : false
}
}
],
"additional" : {
"producer" : "10",
"createAt" : "2016-03-08T20:19:41.000+00:00",
"updateAt" : "2016-03-08T20:19:41.000+00:00"
}
}
]
}
Response Parameters
Sample Response
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
Date: Thu,28 Apr 2022 10:00:00 GMT
Content-Length: 250
1.9.7.26.2 Query the Routing Policy List
Typical Scenarios
Routing policy information needs to be queried.

iMaster NCE-Fabric
Functions
Query the routing policy list by condition.
Constraints
HTTP Method
GET
URI
/controller/dc/v3/logicnetwork/rtps


dex 255
charac
ters.

ze 255
charac
ters.
produc No string 0 to 36 - Producer of a -

er charac routing policy.
ters.
Request Parameters
N/A
Sample Request
HTTP
GET /controller/dc/v3/logicnetwork/rtps?pageIndex=1&pageSize=1 HTTP/1.1
Host: 192.168.1.125:18002
X-ACCESS-TOKEN: x-

iMaster NCE-Fabric
Response Parameters
Table 1-1452 RtpPagedDtoWrapper parameters

eter t Value
rtp ARRAY For details, see Table RTP -

ENCE

um ] of routing
policies
queried.

dex

ze
Table 1-1453 RtpDto parameters

eter t Value

65309"
name string 1 to 200 - Name of a "bfd1"

characters. routing policy
configured on
a forwarding
device, which
cannot be
updated after
being
referenced.

iMaster NCE-Fabric

eter t Value
deploy string 0 to 200 - Alias of the "bfd1"

Policy characters. routing policy
Name configured on
the forwarding
device. The
alias cannot be
changed after
the routing
policy is
referenced.

be updated.
rtpTyp string ● bestEffortPat - Policy type, "general"

e h which cannot
● nfviExport be updated.
● dci
● general
ipVersi string 1 to 64 - IP version, "ipv4"

on characters. which cannot
be updated.
related array< Each item has 0 - Associated ["DBB702C3-7

Extern string> to 50 external 719-4FE6-
alGate characters. gateway ID. A5AD-3A9C9E2
wayIds 65309"]
device array< Each item has 0 - Device group ["DBB702C3-7

GroupI string> to 50 ID. This 719-4FE6-
ds characters. parameter is A5AD-3A9C9E2
valid only 65309"]
when the
policy type is
set to common
policy. The
value cannot
be changed.

iMaster NCE-Fabric

eter t Value
device array< Each item has 0 - Device group ["deviceGroup

Group string> to 50 name. This Name"]
Names characters. parameter is
valid only
when the
policy type is
set to common
policy. The
value cannot
be changed.
ipPrefi array< - - IP prefix. This ["192.168.1.0/2

xes string> parameter is 4"]
valid only
when the
policy type is
set to Telco
Cloud Egress
Routing Policy.
dciRou ARRAY For details, see Table DCI policy set. -

tePolic _REFER 1-1454. This parameter
y ENCE is valid only
when the
policy type is
DCI.
thirdPa boolea - false Valid when the false

rtyEna n DCI routing
ble policy is
configured. If
this function is
enabled, the
DCI gateway
advertises
inclusive Type
3 routes
together with
IRB host
routes.
merge boolea - false Whether to false

n incrementally
update the
node of the
routing policy.

iMaster NCE-Fabric

eter t Value
rtpNod ARRAY For details, see Table DCI policy type, -

e _REFER 1-1455. which can be
ENCE DciImport,
DciExport, or
DciDyeing. The
value cannot
be changed.

Table 1-1454 DciRoutePolicyDto parameters

eter t Value

65309"
name string 1 to 200 - Name of a "bfd1"

characters. routing policy
configured on
a forwarding
device, which
cannot be
updated after
being
referenced.
dciTyp string 1 to 64 - DCI policy type, "DciImport"

e characters. which can be
DciImport,
DciExport, or
DciDyeing. The
value cannot
be changed.
startN int32 [1-20000] 101 Start node ID 101

odeId of the export
routing policy
applied by an
L3DCI service.

iMaster NCE-Fabric
Table 1-1455 RtpNodeDto parameters

eter t Value
index int32 [0-65535] - Routing policy 1

node, which
cannot be
updated.
mode int32 - - Whether to 1

deliver the
goto next-node
command.
gotoN boolea - false Whether to false

extNod n deliver the
e goto next-node
command.
match REFER For details, see Table Match -

action REFER For details, see Table Action -

ENCE 1-1461. Information.
Table 1-1456 MatchDto parameters

eter t Value
ipPrefi ARRAY For details, see Table IP prefix -

x _REFER 1-1457. information.
ENCE
tag int64 [1-4294967295 - Route tag, 82345

] which cannot
be updated.
comm ARRAY For details, see Table Community -

unity _REFER 1-1458. information.
ENCE
extCo ARRAY For details, see Table ExtCommunity -

mmuni _REFER 1-1459.

IMaster NCE-Fabric V100R021C10 RESTful API Development Guide

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

IMaster NCE-Fabric V100R021C10 RESTful API Development Guide

Uploaded by

Copyright:

Available Formats

iMaster NCE-Fabric

API Development Guide

HUAWEI TECHNOLOGIES CO., LTD.

Trademarks and Permissions

Huawei Technologies Co., Ltd.

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. i

1 RESTFul API Reference........................................................................................................... 1

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. ii

1.8.2.5 MIB1 Trap Sample..........................................................................................................................................................61

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. iii

1.9.1.12 Log Out a Session V2 (Compatible with Earlier Versions)......................................................................... 154

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. iv

1.9.2.6 ZTP Underlay Topology Management..................................................................................................................266

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. v

1.9.3.5.1 Import Host Access Links in a Batch................................................................................................................. 381

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. vi

1.9.4.4.4 Update BFD System Configuration.................................................................................................................... 524

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. vii

1.9.5.4 Router.............................................................................................................................................................................. 684

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. viii

1.9.5.10.2 Query Security Rules.............................................................................................................................................799

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. ix

1.9.5.17.1 Create an IPsec Site Connection....................................................................................................................... 900

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. x

1.9.6.2.2 Query All Tenants.................................................................................................................................................. 1044

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xi

1.9.7.3.3 Query Information About All Logical Access Switches............................................................................. 1203

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xii

1.9.7.6.27 Switch Active and Standby Fabrics of a Logical Router......................................................................... 1375

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xiii

1.9.7.13 Logical Topology (Not Recommended).......................................................................................................... 1517

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xiv

1.9.7.19 Flow Rule................................................................................................................................................................... 1673

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xv

1.9.7.25.5 Query Routing Whitelist Information by Condition................................................................................ 1788

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xvi

1.9.7.30.3 Query Layer 2 DCI Instances........................................................................................................................... 1957

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xvii

1.9.7.36.3 VMM........................................................................................................................................................................ 2102

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xviii

1.9.8.7.4 Query East-West Traffic Applications by ID................................................................................................. 2272

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xix

1.9.9.4.2 Query All Multicast Replication Addresses of BUM Packets...................................................................2397

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xx

1.9.10.4.5 Delete an SFC Policy by ID............................................................................................................................... 2569

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxi

1.9.11.6.1 Configure TCP_UDP Flow Analysis Rules.................................................................................................... 2701

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxii

1.9.11.13.11 Querying Historical Data............................................................................................................................. 2890

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxiii

1.9.12.1.7 Querying WebSocket Subscription Information....................................................................................... 3035

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxiv

1.9.14.1.1 Report All Resource and Relationship Data............................................................................................... 3134

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxv

1.9.14.7.2 Querying Subscription Request Information in Batches........................................................................ 3296

2 Restconf API Reference....................................................................................................3399

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxvi

2.1.1.2 Query Security Groups............................................................................................................................................ 3403

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxvii

2.1.8.3 Query a Port by Name............................................................................................................................................ 3529

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxviii

2.1.15.3 Query a Router by Router ID.............................................................................................................................. 3644

Issue 01 (2022-04-29) Copyright © Huawei Technologies Co., Ltd. xxix