API Reference for Cisco Enterprise Network Function Virtualization Infrastructure Software

178 Pages·2017·2.8 MB·English

API Reference for Cisco Enterprise Network Function Virtualization
Infrastructure Software
FirstPublished:2017-03-31
LastModified:2019-10-09
AmericasHeadquarters
CiscoSystems,Inc.
170WestTasmanDrive
SanJose,CA95134-1706
USA
http://www.cisco.com
Tel:[phone]
800553-NETS(6387)
Fax:[phone]
©2018CiscoSystems,Inc.Allrightsreserved.
CONTEN TS
PART I NFVISRelatedAPIs 13
CHAPTER 1 IntroductiontoCiscoEnterpriseNFVISRESTAPIs 1
RESTAPICredentials 1
APIRequestMethods 1
CHAPTER 2 SystemandIPConfigurationAPIs 3
SystemConfigurationAPIs 3
Example:PUTSystemConfigurationAPI 5
Example:GETSystemDetailsAPI 6
SystemRoutesAPIs 9
Example:POSTSystemRouteAPI 9
Example:PUTSystemRouteAPI 10
Example:GETSystemRouteAPI 11
Example:DELETESystemRouteAPI 12
VLANAPIs 13
Example:PUTVLANAPI 14
Example:GETVLANAPI 15
Example:DELETEVLANAPI 18
UserManagementAPIs 20
Example:POSTAddUserAPI 22
Example:POSTChangeRoleAPI 22
Example:POSTChangePasswordAPI 22
Example:GETUsersAPI 23
Example:DeleteUserAPI 24
Example:POSTConfigureMinimumPasswordLength 24
APIReferenceforCiscoEnterpriseNetworkFunctionVirtualizationInfrastructureSoftware
iii
Contents
Examples:POSTConfigurePasswordLifetime 24
Examples:POSTConfigureAccountInactivityPeriod 26
Example:POSTActivateanInactiveUserAccount 27
TACACS+ServerAPIs 27
Example:POSTTACACSServerAPI 28
Example:GETTACACSServerAPI 28
Example:PUTTACACSServerAPI 30
Example:DELETETACACSServerAPI 30
TrustedIPConnectionAPIs 31
Example:PUTTrustedIPConnectionAPI 32
Example:GETTrustedIPConnectionAPI 33
BannerandMessageAPIs 34
Example:PUTBanner-MOTDAPI 35
Example:GETBanner-MOTDAPI 36
Example:DELETEBanner-MOTDAPI 37
DiskSpaceAPIs 38
Example:GETDiskSpaceAPI 38
SystemTimeAPIs 40
Example:PUTSystemTimeManualTimeAPI 41
Example:PUTSystemTimePreferredServerAPI 42
Example:PUTSystemTimeBackupServerAPI 43
Example:PUTSystemTimeTimezoneAPI 43
Example:GETSystemTimeAPI 44
PlatformDetailsAPI 45
PortDetailsAPIs 47
PortalAccessAPIs 49
Example:PUTPortalAccess(Enable/Disable) 50
Example:GETPortalAccessAPI 50
SystemLogAPIs 51
Example:POSTSystemLogAPI 52
Example:GETSystemLogAPI 53
DPDKSupportAPIs 54
BackupandRestoreAPIs 55
RouteDistributionAPIs 56
APIReferenceforCiscoEnterpriseNetworkFunctionVirtualizationInfrastructureSoftware
iv
Contents
DynamicSR-IOVAPIs 57
CHAPTER 3 PnPAPIs 59
CertificateCreationAPIs 59
Example:POSTSigningRequestAPI 61
Example:POSTInstallCertificateAPI 61
Example:POSTUseCertificateAPI 62
PnPActionAPIs 63
Example:POSTPnPActionAPI 63
PnPAPIs 64
PnPServerAPIs 64
Example:PUTPnPServerAPI 65
Example:GETPnPServerAPI 66
Example:DELETEPnPServerAPI 67
CHAPTER 4 ResourceAPIs 69
CPUAllocationSummaryAPI 69
Example:GETCPUAllocationSummaryAPI 69
ResourcesCPUAPIs 70
Example:GETResourcesCPUAPI 70
ResourcePrecheckAPIs 71
Example:GETResourcePrecheckAPI 72
ResourcesVMAPIs 73
Example:GETResourcesVNFAPI 73
CHAPTER 5 NetworksandBridgesAPIs 75
BridgeAPIs 75
Example:POSTBridgeCreationAPI 76
Example:GETBridgeConfigurationAPI 77
Example:DELETEBridgeAPI 78
NetworkCreationAPIs 79
Example:POSTNetworkAPI 80
CHAPTER 6 VMLifecycleManagementAPIs 83
APIReferenceforCiscoEnterpriseNetworkFunctionVirtualizationInfrastructureSoftware
v
Contents
VMImageRegistrationAPIs 83
Example:POSTImageRegistrationAPI 85
Example:POSTImageRegistrationtoExternalDiskAPI 85
Example:GETImageConfigurationAPI 86
Example:GETImageStatusAPI 87
Example:DELETEImageRegistrationAPI 88
CustomFlavorCreationAPIs 88
Example:POSTFlavorAPI 90
Example:GETFlavorConfigurationAPI 90
Example:GETFlavorStatusAPI 91
VMDeploymentAPIs 92
Example:POSTVMDeploymentAPIforCiscoISRv 93
Example:DELETEVMDeploymentAPI 97
ExamplesforVMDeploymentPayloadwithBootstrapConfigurationOptions 98
AddingorEditingavNICUsingtheVMDeploymentAPI 103
ChangingtheFlavorUsingtheVMDeploymentAPI 105
VMActionAPIs 105
Example:POSTStartVMAPI 106
Example:POSTStopVMAPI 107
Example:POSTRestartVMAPI 108
Example:POSTEnableVMMonitoringAPI 108
Example:POSTDisableVMMonitoringAPI 109
VMNetworkAPIs 110
NetworkFileSystemAPIs 111
VNCConsoleStartAPI 112
VMMultiSerialPortAPIs 113
CHAPTER 7 SystemMonitoringAPIs 115
HostCPUStatsAPIs 115
Example:GETHostCPUStatsAPI 116
HostCPUTableAPI 118
Example:GETHostCPUTableAPI 118
HostDiskStatsAPIs 121
Example:GETHostDiskStatsAPI 122
APIReferenceforCiscoEnterpriseNetworkFunctionVirtualizationInfrastructureSoftware
vi
Contents
HostMemoryStatsAPIs 128
Example:GETHostMemoryStatsAPI 128
HostMemoryTableAPIs 129
Example:GETHostMemoryTableAPIs 130
HostPortStatsAPIs 131
Example:GETHostPortStatsAPI 132
HostPortTableAPIs 134
Example:GETHostPortTableAPI 135
VNFCPUStatsAPIs 137
Example:GETVNFCPUStatsAPI 138
VNFDiskStatsAPIs 140
Example:GETVNFDiskStatsAPI 140
VNFMemoryStatsAPI 142
Example:GETVNFMemoryStatsAPI 142
VNFPortStatsAPIs 144
Example:GETVNFPortStatsAPI 144
CHAPTER 8 SystemOperationsAPIs 149
ExternalDisksAPI 149
Example:GETExternalDisksAPI 149
FileListAPIs 150
Example:GETFileListAPIs 150
FileDeleteAPI 152
Example:FileDeleteAPI 153
USBMountAPI 154
Example:POSTUSBMountAPI 154
Example:POSTUSBUnmountAPI 155
Example:GETUSBMountPoint 156
USBCopyAPI 157
Example:POSTUSBCopyAPI 157
HostRebootAPI 158
DHCPRenewAPI 158
Example:POSTWANDHCPRenewAPI 158
Example:BridgeDHCPRenew 159
APIReferenceforCiscoEnterpriseNetworkFunctionVirtualizationInfrastructureSoftware
vii
Contents
CHAPTER 9 SPANSessionandPacketCaptureAPIs 161
Example:POSTSPANSessionAPI 162
Example:GETSPANSessionAPIs 163
PacketCaptureAPIs 166
Example:POSTPacketCaptureAPIs 167
CHAPTER 10 UpgradePackageAPIs 169
UpgradePackageRegisterAPI 169
Example:POSTUpgradePackageRegisterAPI 170
Example:GETUpgradePackageRegisterAPI 171
Example:DELETEUpgradePackageRegisterAPI 172
UpgradeApply-ImageAPIs 173
Example:POSTUpgradeApply-ImageAPI 173
Example:GETUpgradeApply-ImageAPI 174
Example:DELETEUpgradeApply-ImageAPI 175
CHAPTER 11 FactoryDefaultResetAPIs 177
Example:POSTFactoryDefaultResetAll 177
Example:POSTFactoryDefaultResetAllExceptImages 178
Example:POSTFactoryDefaultResetAllExceptImagesConnectivity 179
CHAPTER 12 SyslogSupportAPIs 181
Example:POSTSyslogServer 181
Example:PUTRemoteLoggingHostConfiguration 182
Example:DELETERemoteLoggingHostConfiguration 183
Example:PUTSyslogSeverity 184
Example:PUTSyslogFacility 185
Example:GETRemoteLoggingHost 186
CHAPTER 13 SNMPSupportAPIs 189
Example:POSTConfiguringSNMPCommunities 190
Example:POSTSNMPTraps 190
APIReferenceforCiscoEnterpriseNetworkFunctionVirtualizationInfrastructureSoftware
viii
Contents
Example:POSTSNMPHost 190
Example:POSTSNMPUsers 191
Example:POSTSNMPGroups 191
Example:GETSNMPConfigurations 191
CHAPTER 14 TACACSandRADIUSSupportAPIs 193
TACACSSupportAPIs 193
Example:POSTTACACSServer 193
Example:PUTTACACSServer 194
Example:GETTACACSServerAPI 195
Example:DELETETACACSServer 196
RADIUSSupportAPIs 197
Example:GETRADIUSServer 197
Example:POSTRADIUSServer 198
Example:PUTRADIUSServer 198
Example:DELETERADIUSServer 198
CHAPTER 15 PortandPortChannelAPIs 199
Example:GETPortandPortChannelInformationAPI 202
Example:POSTCreateaPortChannelAPI 206
Example:PUTAddaPorttoaPortChannelAPI 207
Example:PUTAddaPortChanneltoanExistingBridgeAPI 208
Example:PUTConfiguretheLACPModeofaPortChannelAPI 209
Example:PUTConfiguretheBondModeofaPortChannelAPI 210
Example:PUTConfigureTrunksonaPortChannelAPI 211
Example:DELETERemoveaPortfromaPortChannelAPI 212
Example:PUTRemoveaPortChannelfromaBridgeAPI 212
Example:DELETEDeleteaPortChannelAPI 213
Example:GETLLDPInformationAPI 214
Example:PUTEnableLLDPConfigurationAPI 217
Example:GETPortAdminStatusAPI 218
Example:PUTConfigurePortAdminStatusAPI 219
Speed,AutonegandDuplexAPIs 220
APIReferenceforCiscoEnterpriseNetworkFunctionVirtualizationInfrastructureSoftware
ix
Contents
CHAPTER 16 PortSecurityAPIs 221
CHAPTER 17 SecureOverlayAPIs 223
SingleIPConfigurationAPIs 226
CHAPTER 18 BGPSupportAPIs 229
BGPoverMPLSAPIs 231
PART II SwitchRelatedAPIs 233
CHAPTER 19 DOT1xAPIs 235
DOT1xguest-vlanTimeoutValueAPIs 235
DOT1xDefaultauthenticationAPIs 237
DOT1xSystemAuthenticationControlAPIs 237
RADIUSSourceInterfaceAddressAPIs 238
CHAPTER 20 IPGatewayAPIs 241
IPRouteAPIs 242
CHAPTER 21 Spanning-TreeAllorIndividualElementsAPIs 243
CreateSpanning-TreeAPIs 245
ModifySpanning-TreeAPIs 247
DeleteSpanning-TreeAPIs 248
CHAPTER 22 InterfaceStatAPIs 251
InterfacePortAPIs 253
CHAPTER 23 InterfaceGigabitEthernetSwitchportAPIs 255
CHAPTER 24 InterfaceGigabitEthernetSpanning-TreeAPIs 259
CHAPTER 25 SPAN/RSPANAPIs 261
APIReferenceforCiscoEnterpriseNetworkFunctionVirtualizationInfrastructureSoftware
x