NSX 6.2 vSphere API Guide

514 Pages·2016·4.88 MB·English

NSX vSphere API Guide
NSX 6.2 for vSphere
This document supports the version of each product listed and
supports all subsequent versions until the document is replaced
by a new edition.
EN-001545-06

Contents
About This Book 21
1 Overview of NSX 23
NSX Components 23
Data Plane 24
Control Plane 24
Management Plane 24
Consumption Platform 24
NSX Services 24
Logical Switches 25
Logical Routers 25
Logical Firewall 25
Logical Virtual Private Networks (VPN)s 25
Logical Load Balancer 25
Service Composer 25
NSX Extensibility 26
An Introduction to REST API for NSX Users 26
How REST Works 26
About the REST API 26
RESTful Workflow Patterns 27
For More Information About REST 27
Using the NSX REST API 27
Ports Required for NSX REST API 28
2 Installing Components 29
Installing Licenses 29
Evaluating NSX License Capacity Usage 29
Working with Network Virtualization Components 30
Install Network Virtualization Components 30
Delete Network Virtualization Components 31
Working with VXLAN for Logical Switches 31
Working with Controllers 32
Add Controller 32
Query Controllers 32
Query Controller Addition or Deletion Details 33
Query Controller Tech Support Logs 33
Delete Controller 33
Query Cluster Information 33
Modify Cluster Configuration 34
Add Controller Syslog Exporter 34
Query Controller Syslog Exporter 34
Delete Controller Syslog Exporter 35
Backup Controller Data 35
Working with Segment IDs 35
Add a new Segment ID Range 35
Query all Segment ID Ranges 35
Query a Specific Segment ID Range 36
VMware, Inc. 3
NSX-v API Programming Guide
Update a Segment ID Range 36
Delete a Segment ID Range 36
Configure VXLAN 37
Install VXLAN 37
Delete VXLAN 38
Delete VXLAN with vdsContext 38
Working with Network Scopes 38
Create a Network Scope 38
Edit a Network Scope 39
Update Attributes on a Network Scope 39
Query existing Network Scopes 39
Query a Specific Network Scope 40
Delete a Network Scope 41
Repair Logical Switches in a Network Scope 41
Reset Communication 41
Query Features on Cluster 42
Query Status of Specific Resources 42
Query Status of Child Resources 43
Query Status of Resources by Criterion 44
Installing NSX Edge 45
NSX Edge Services Gateway 45
Logical Router 46
Manage Tuning Configuration 46
Query Tuning Configuration 46
Modify Tuning Configuration 46
Installing NSX Edge Services Gateway 47
Installing a Logical Router 50
Working with Services 51
Install Security Fabric 52
Service Dependency 52
Deploying a Service with a Dependency 53
Identify Service Dependency 53
Uninstall Service Dependency 53
Query Installed Services 53
Query Details about a Service 54
Query Clusters 54
Query Agents on Host 55
Query Agent Information 55
Query Agents for Deployment 56
Working with Conflicting Agencies 57
Query Conflicts 57
Restore Conflicting Agencies 58
Delete Conflicting Agencies 58
Delete Deployment Units 58
Uninstalling Services 58
3 Managing the NSX Manager Appliance 61
Configuring NSX Manager with vCenter Server 61
Configure vCenter Server with NSX Manager 61
Query Configuration Details 62
Certificate Management 62
Generate CSR Certificate 62
Download CSR Certificate 63
Upload Certificate Chain 63
4 VMware, Inc.
Contents
Query Certificates 63
Upload Keystore File 64
Resource Management 64
Query Global Appliance Manager Information 64
Query Summary Appliance Manager Information 64
Query Component Information 65
Reboot Appliance Manager 66
Query Appliance Manager CPU 66
Query Appliance Manager Uptime 66
Query Appliance Manager Memory 66
Query Appliance Manager Storage 67
Working with Network Settings 67
Query Network Information 67
Configure DNS Servers 67
Delete DNS Servers 68
Working with Time Settings 68
Configure Time Settings 68
Query Time Settings 68
Delete Time Settings 68
Working with Locale Settings 69
Configure Locale 69
Query Locale 69
Working with Syslog Servers 69
Configure Syslog Servers 69
Query Syslog Servers 70
Retrieves syslog servers. 70
Delete Syslog Servers 70
Deletes syslog servers. 70
Components Management 70
Query Components 70
Query Specific Component 71
Query Component Dependencies 71
Query Specific Component Dependents 72
Query Component Status 72
Toggle Specific Component Status 72
Restart Appliance Management Web Application 72
Working with Backup and Restore 73
Configure Backup Settings 73
Configure On‐Demand Backup 74
Query Backup Settings 74
Delete Backup Configuration 75
Query Available Backups 75
Restore Data 75
Working with Tech Support Logs 75
Generate Tech Support Logs 75
Download Tech Support Logs 76
Querying NSX Manager Logs 76
Get NSX Manager System Events 76
Get NSX Manager Audit Logs 76
Working with Support Notifications 77
Query Notifications 77
Delete all Notifications 77
Acknowledge Notifications 77
VMware, Inc. 5
NSX-v API Programming Guide
4 Upgrading NSX Components 79
Upgrading NSX Manager 79
Upload Upgrade Bundle 80
Query Upgrade Information 80
Begin Upgrade 80
Query Upgrade Status 81
Upgrading Controllers 81
Backup Controllers 81
Query Controller Upgrade Availability 82
Upgrade Controllers 82
Query Controller Upgrade Status 82
Upgrading Network Virtualization Components 82
Upgrading Distributed Firewall 83
Upgrading NSX Edge 83
Upgrading Services 84
5 User Management 85
Configuring SSO on NSX Manager 85
Query SSO Details 86
Query SSO Configuration Status 86
Delete SSO Configuration 86
User Management 86
Get Information About a User 86
Enable or Disable a User Account 87
Change NSX Controller Password 87
Remove Role Assignment 88
Role Management 88
Get Role for a User 88
Get Role for a NSX Manager User 89
Add Role and Resources for a User 89
Change User Role 90
Get List of Possible Roles 90
Get List of Scoping Objects 91
Delete User Role 91
6 Grouping Objects 93
Working with Security Groups 93
Create Security Group 93
Query Security Groups 95
Query Applicable Members for a Security Group 97
Query all Members of a Security Group 98
Query Security Group Objects 98
Query Security Groups that contain a Virtual Machine 99
Modify a Security Group 99
Delete a Security Group 99
Add Member to Security Group 99
Delete Member from Security Group 100
Working with IPsets 100
Create an IPset 100
Query IPsets 101
Query Details of an IPset 101
Modify an IPset 101
Delete an IPset 102
Working with MACsets 102
Create a MACset on a Scope 102
6 VMware, Inc.
Contents
List MACsets Created on a Scope 102
Get Details of a MACset 103
Modify an Existing MACset 103
Delete a MACset 103
Working with Services 104
List Services on a Scope 104
Add Service 104
Get Details of a Service 105
Modify Service 105
Delete Service 106
Working with Service Groups 106
Add Service Group 106
Query Service Groups 106
Query Details of a Service Group 107
Modify Service Group Details 107
Delete Service Group from Scope 108
Working with the Members of a Service Group 108
Query Service Group Members 108
Add a Member to the Service Group 109
Delete a Member from the Service Group 109
Working with IP Pools 110
Add an IP Pool 110
Query IP Pool Details 110
Modify an IP Pool 111
Allocating a New IP Address 111
Allocating a Specific IP Address 112
Query all IP Pools on Scope 112
Query Allocated IP Addresses 113
Release an IP Address 113
Delete an IP Pool 114
Working with Tags 114
Create Security Tag 114
Apply Tag to Virtual Machine 114
Query Security Tags 114
Query Virtual Machines Assigned to Tag 115
Detach Tag from Virtual Machine 115
Delete Tag 115
7 Working with Logical Switches 117
Preparing for Logical Switches 118
Configuring Switches 118
Prepare Switch 118
Query Configured Switches 118
Query Configured Switches on Datacenter 119
Query Specific Switch 119
Delete Switch 120
Working with Segment IDs 120
Add a new Segment ID Range 120
Query all Segment ID Ranges 120
Query a Specific Segment ID Range 121
Update a Segment ID Range 121
Delete a Segment ID Range 121
Working with Multicast Address Ranges 121
Add a new Multicast Address Range 121
Query all Multicast Address Ranges 122
VMware, Inc. 7
NSX-v API Programming Guide
Get a Specific Multicast Address Range 122
Update a Multicast Address Range 122
Delete a Multicast Address Range 123
Working with Transport Zones 123
Create a Transport Zone 123
Edit a Transport Zone 123
Update Attributes on a Transport Zone 124
Query existing Transport Zones 124
Query a Specific Transport Zone 125
Delete a Transport Zone 126
Working with Logical Switches 126
Create a Logical Switch 126
Attach or Detach a Virtual Machine from a Logical Switch 126
Query all Logical Switches on a Transport Zone 127
Query all Logical Switches on all Transport Zones 127
Query a Specific Logical Switch 128
Modify Control Plane Mode 129
Delete a Logical Switch 129
Working with ARP Suppression and MAC Learning for Logical Switches 129
Managing the Logical Switch UDP Port 130
Get UDP Port 130
Update UDP Port 130
Querying Allocated Resources 130
Testing Multicast Group Connectivity  131
Test Multicast Group Connectivity in a Transport Zone 131
Test Multicast Group Connectivity in a Logical Switch 131
Performing Ping Test 132
8 NSX Edge Logical Router Management 133
Create a Logical Router 133
Query a Logical Router 135
Modify a Router 136
Deleting a Router 137
Working with Interfaces 138
Working with Management Interfaces 138
Configure Management Interfaces 138
Query Management Interfaces 138
Working with all Interfaces 139
Add Interfaces 139
Query Interfaces for a NSX Edge Router 139
Delete Interfaces 140
Delete all Interfaces 141
Manage an NSX Edge Router Interface 141
Retrieve Interface with Specific Index 141
Modify an Interface 141
Delete Interface Configuration 142
Configure Routes 142
Query Routes 145
Delete Routes 147
Manage Global Routing Configuration 147
Specify Global Configuration 148
Query Global Route 148
Manage Static Routing 148
Configure Static Routes 148
8 VMware, Inc.
Contents
Query Static Routes 149
Delete Static Routes 150
Manage OSPF Routes for NSX Edge 150
Configure OSPF 150
Query OSPF 151
Delete OSPF 152
Manage BGP Routes for NSX Edge 152
Configure BGP 152
Query BGP 153
Delete BGP 154
Working with Bridging 155
Configure a Bridge 155
Query Bridge Configuration 155
Query BGP 155
Delete Bridge Configuration 156
9 NSX Edge Services Gateway Management 157
Query Installed Edges 158
Modifying NSX Edge Configuration 162
System Control Edge Configuration 166
Deleting NSX Edge 168
Configuring Edge Services in Async Mode 168
Query Async Job Status 168
Query all Jobs 168
Query active Jobs 169
Configuring Certificates 169
Working with Certificates 169
Create Certificate 169
Create Certificate or Certificate Chain for CSR 170
Query Certificates 170
Delete Certificate 170
Working with Certificate Signing Requests (CSRs) 170
Create CSR 171
Create Self Signed Certificate for CSR 171
Query CSRs 171
Working with Certificate Revocation List (CRL) 172
Create a CRL 172
Query CRL 172
Delete CRL 172
Working with NSX Edge Firewall 172
Configure Firewall 173
Query Firewall Configuration 174
Query Pre Rules 176
Append Firewall Rules  176
Add a Firewall Rule Above a Specific Rule 177
Query Specific Rule 178
Modify Firewall Rule 178
Delete a Firewall Rule 179
Delete Firewall Configuration 179
Manage Global Firewall Configuration 179
Query Global Firewall Configuration 179
Modify Global Configuration 180
Manage Default Firewall Policy 180
Query Default Firewall Policy 181
VMware, Inc. 9
NSX-v API Programming Guide
Modify Default Firewall Policy 181
Query Firewall Statistics 181
Query Firewall Statistics for Rule 182
Disable Firewall 182
Working with NAT 182
Configure NAT 182
Query NAT Rules for an Edge 183
Delete all NAT Rules 184
Add a NAT Rule above a Specific Rule 184
Append NAT Rules  185
Modify a NAT Rule 185
Delete a NAT Rule 185
Working with Routing 186
Configure Routes 186
Query Routes 190
Delete Routes 190
Manage Global Routing Configuration 190
Specify Global Configuration 190
Query Global Route 191
Manage Static Routing 191
Configure Static Routes 191
Query Static Routes 192
Delete Static Routes 192
Manage OSPF Routes for NSX Edge 193
Configure OSPF 193
Query OSPF 194
Delete OSPF 195
Manage ISIS Routes for NSX Edge 195
Configure ISIS 195
Query ISIS 196
Delete ISIS 197
Manage BGP Routes for NSX Edge 197
Configure BGP 198
Query BGP 199
Delete BGP 200
Working with Load Balancer 200
Configure Load Balancer 200
Query Load Balancer Configuration 207
Delete Load Balancer Configuration 207
Manage Application profiles 207
Append Application Profile 207
Modify Application Profile 208
Query Application Profile 208
Query all Application Profiles 208
Delete Application Profile 209
Delete all Application Profiles 209
Manage Application Rules 209
Append Application Rule 209
Modify Application Rule 210
Query Application Rule 210
Query all Application Rules 210
Delete Application Rule 210
Delete all Application Rules 211
Manage Load Balancer Monitors 211
10 VMware, Inc.