net.nuage.vsp.acs.client.api

Interface NuageVspApiClient

All Known Implementing Classes:

NuageVspApiClientImpl

public interface NuageVspApiClient

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	NuageVspApiClient.ExistingDhcpOptionStrategy

Method Summary

Modifier and Type	Method and Description
List<NuageVspObject>	addVMInterfaceToVM(VspNetwork vspNetwork, VspVm vspVm, VspNic vspNic, NetworkDetails attachedNetworkDetails, NuageVspObject vm, DhcpOptions dhcpOptions)
String	allocateFIPToVPortInVsp(NetworkDetails attachedNetworkDetails, String vportId, String vspSharedNetworkId, String staticNatIp, String staticNatIpUuid, String nicSecondaryIp4Address, String nicSecondaryIpUuid)
String	applyStaticNatInVsp(NetworkDetails attachedNetworkDetails, String vportId, VspStaticNat vspStaticNat)
List<NuageVspObject>	buildVmInterfacesList(VspVm vspVm, VspNic... vspNics)
void	cleanUpDomainAndTemplate(String enterpriseId, String networkUuid, String domainTemplateName)
void	createDhcpOptions(NuageVspApiClient.ExistingDhcpOptionStrategy existingOptionStrategy, NetworkDetails attachedNetworkDetails, VspNetwork vspNetwork, DhcpOptions dhcpOptions) Depending on the option strategy new dhcp options get created on the vsd for a subnet
void	createDhcpOptions(NuageVspApiClient.ExistingDhcpOptionStrategy existingOptionStrategy, NuageVspEntity nuageVspEntity, String nuageVspEntityUuid, String nuageVspEntityId, VspNetwork vspNetwork, DhcpOptions dhcpOptions) Depending on the option strategy new dhcp options get created on the vsd for the specified vsd entity (vport or subnet)
String	createEnterpriseInVSP(String enterpriseExternalUuid, String enterpriseDescription)
NuageVspObject	createGroupInEnterprise(String projectOrAccountName, String projectOrAccountUuid, String vsdEnterpriseId)
NetworkRelatedVsdIds	createIsolatedL2NetworkWithDefaultACLs(VspNetwork vspNetwork)
NetworkRelatedVsdIds	createNetworkConfigurationWithDefaultACLs(VspNetwork vspNetwork, VspDhcpDomainOption vspDhcpOptions)
String	createUserInEnterprise(String vsdEnterpriseId, String userNameUuid, String firstName, String lastName, String email, String password)
List<NuageVspObject>	createVMInVSP(VspNetwork vspNetwork, VspVm vspVm, VspNic vspNic, NetworkDetails attachedNetworkDetails, DhcpOptions dhcpOptions)
void	createVportInVsp(VspNic vspNic, VspNetwork vspNetwork, List<NuageVspObject> vmInterfaceList, NetworkDetails attachedNetworkDetails, DhcpOptions dhcpOptions)
void	deleteEnterpriseInVsp(String enterpriseExternalUuid, String enterpriseDescription)
void	deleteQuietly(NuageVspEntity entityType, String entityId)
void	deleteSharedResourceInVSP(NuageVspConstants.SharedNetworkType resourceType, String staticNatNetworkUuid, String staticNatVlanGateway, String staticNatVlanNetmask)
void	deleteVM(String vmUuid, String vmId)
void	deleteVmInterface(String vmUuid, String macAddr, String vmInterfaceID)
boolean	entityExists(NuageVspEntity entityType, String entityUuid) Check if an entity exists in the VSD
String	findEntityByExternalUuid(NuageVspEntity entityType, String entityId, NuageVspEntity childEntityType, String externalId)
String	findEntityIdByExternalUuid(NuageVspEntity entityType, String entityId, NuageVspEntity childEntityType, String externalId)
String	findEntityUsingFilter(NuageVspEntity entityType, String entityId, NuageVspEntity childEntityType, NuageVspAttribute filterAttr, Object filterAttrValue)
String	findEntityUsingFilter(NuageVspEntity entityType, String entityId, NuageVspEntity childEntityType, NuageVspFilter filter)
<T> T	findFieldValueByExternalUuid(NuageVspEntity entityType, String entityId, NuageVspEntity childEntityType, String externalId, NuageVspAttribute fieldName)
VspNetwork	findIsolatedL3Network(VspNetwork vspNetwork)
Pair<Boolean,String>	findOrCreateSharedResource(boolean findByExternalId, NuageVspConstants.SharedNetworkType resourceType, String staticNatNetworkUuid, String staticNatVlanGateway, String staticNatVlanNetmask, boolean staticNatVlanUnderlay, String networkName)
String	generateCmsIdForNuageVsp(String cmsName)
String	getEnterprise(String domainUuid)
String	getEnterpriseName(String domainName, String domainPath)
String	getEntityId(String jsonString, NuageVspEntity entityType)
String	getIsolatedDomain(boolean throwExceptionWhenNotFound, String enterpriseId, NuageVspEntity attachedNetworkType, String vpcOrSubnetUuid)
String	getIsolatedDomain(String enterpriseId, NuageVspEntity attachedNetworkType, String vpcOrSubnetUuid)
Pair<String,String>	getIsolatedSubNetwork(boolean throwExceptionWhenNotFound, String enterpriseId, VspNetwork vspNetwork)
Pair<String,String>	getIsolatedSubNetwork(String enterpriseId, VspNetwork vspNetwork)
String	getOrCreateVSPEnterprise(String domainUuid, String domainName, String domainPath)
Pair<String,String>	getOrCreateVSPEnterpriseAndGroup(String networksDomainName, String networksDomainPath, String networksDomainUuid, String networksAccountName, String networksAccountUuid, Optional<String> maybeEnterpriseId)
NuageVspObject	getResource(NuageVspEntity nuageEntityType, String entityId)
String	getResources(NuageVspEntity entityType)
<T> T	getResources(NuageVspEntity entityType, Class<T> type)
String	getResources(NuageVspEntity enterprise, NuageVspFilter filter)
String	getResources(NuageVspObject parent, NuageVspEntity childEntityType)
NuageVspObject	getVMDetails(String vmUuid)
boolean	isExistingResource(NuageVspEntity entity, String entiyId) Checks if the entity with the specified entityId is present on the VSD.
boolean	isKnownCmsIdForNuageVsp(String cmsId)
void	login() Login to the Nuage VSP
List<NuageVspObject>	parseJsonString(NuageVspEntity entity, String json)
<T> T	parseJsonString(NuageVspEntity entity, String json, Class<T> type)
void	releaseFIPFromVsp(NetworkDetails attachedNetworkDetails, String vportId, String staticNatIpUuid, String nicSecondaryIpUuid)
void	removeAllDhcpOptionsWithCode(NuageVspEntity nuageVspEntity, String externalUuid, String entityId, Set<Integer> dhcpOptionCodesToRemove) Removes all specified dhcp options from the specified nic.
boolean	removeCmsIdForNuageVsp(String cmsId)
void	updateVPortWithFloatingIPId(String vportId, String floatingIPId)

Method Detail

createVMInVSP

List<NuageVspObject> createVMInVSP(VspNetwork vspNetwork,
                                   VspVm vspVm,
                                   VspNic vspNic,
                                   NetworkDetails attachedNetworkDetails,
                                   DhcpOptions dhcpOptions)
                            throws NuageVspException

Throws:

NuageVspException

addVMInterfaceToVM

List<NuageVspObject> addVMInterfaceToVM(VspNetwork vspNetwork,
                                        VspVm vspVm,
                                        VspNic vspNic,
                                        NetworkDetails attachedNetworkDetails,
                                        NuageVspObject vm,
                                        DhcpOptions dhcpOptions)
                                 throws NuageVspException

Throws:

NuageVspException

findOrCreateSharedResource

Pair<Boolean,String> findOrCreateSharedResource(boolean findByExternalId,
                                                NuageVspConstants.SharedNetworkType resourceType,
                                                String staticNatNetworkUuid,
                                                String staticNatVlanGateway,
                                                String staticNatVlanNetmask,
                                                boolean staticNatVlanUnderlay,
                                                String networkName)
                                         throws NuageVspException

Throws:

NuageVspException

deleteSharedResourceInVSP

void deleteSharedResourceInVSP(NuageVspConstants.SharedNetworkType resourceType,
                               String staticNatNetworkUuid,
                               String staticNatVlanGateway,
                               String staticNatVlanNetmask)
                        throws NuageVspException

Throws:

NuageVspException

applyStaticNatInVsp

String applyStaticNatInVsp(NetworkDetails attachedNetworkDetails,
                           String vportId,
                           VspStaticNat vspStaticNat)
                    throws NuageVspException

Throws:

NuageVspException

getResource

NuageVspObject getResource(NuageVspEntity nuageEntityType,
                           String entityId)
                    throws NuageVspApiException

Throws:

NuageVspApiException

isExistingResource

boolean isExistingResource(NuageVspEntity entity,
                           String entiyId)

Checks if the entity with the specified entityId is present on the VSD.

Parameters:

entity -

entiyId -

Returns:

login

void login()
    throws NuageVspApiException

Login to the Nuage VSP

Throws:

NuageVspException

NuageVspApiException

entityExists

boolean entityExists(NuageVspEntity entityType,
                     String entityUuid)
              throws NuageVspException

Check if an entity exists in the VSD

Parameters:

entityType - The type of the entity

entityUuid - The UUID of the entity

Returns:

True if exists, false if not

Throws:

NuageVspException

buildVmInterfacesList

List<NuageVspObject> buildVmInterfacesList(VspVm vspVm,
                                           VspNic... vspNics)

deleteVmInterface

void deleteVmInterface(String vmUuid,
                       String macAddr,
                       String vmInterfaceID)
                throws NuageVspException

Throws:

NuageVspException

deleteVM

void deleteVM(String vmUuid,
              String vmId)

getVMDetails

NuageVspObject getVMDetails(String vmUuid)
                     throws NuageVspException

Throws:

NuageVspException

getOrCreateVSPEnterprise

String getOrCreateVSPEnterprise(String domainUuid,
                                String domainName,
                                String domainPath)
                         throws NuageVspException

Throws:

NuageVspException

getOrCreateVSPEnterpriseAndGroup

Pair<String,String> getOrCreateVSPEnterpriseAndGroup(String networksDomainName,
                                                     String networksDomainPath,
                                                     String networksDomainUuid,
                                                     String networksAccountName,
                                                     String networksAccountUuid,
                                                     Optional<String> maybeEnterpriseId)
                                              throws NuageVspException

Throws:

NuageVspException

createEnterpriseInVSP

String createEnterpriseInVSP(String enterpriseExternalUuid,
                             String enterpriseDescription)
                      throws NuageVspException

Throws:

NuageVspException

deleteEnterpriseInVsp

void deleteEnterpriseInVsp(String enterpriseExternalUuid,
                           String enterpriseDescription)
                    throws NuageVspException

Throws:

NuageVspException

createUserInEnterprise

String createUserInEnterprise(String vsdEnterpriseId,
                              String userNameUuid,
                              String firstName,
                              String lastName,
                              String email,
                              String password)
                       throws NuageVspException

Throws:

NuageVspException

createGroupInEnterprise

NuageVspObject createGroupInEnterprise(String projectOrAccountName,
                                       String projectOrAccountUuid,
                                       String vsdEnterpriseId)
                                throws NuageVspException

Throws:

NuageVspException

createNetworkConfigurationWithDefaultACLs

NetworkRelatedVsdIds createNetworkConfigurationWithDefaultACLs(VspNetwork vspNetwork,
                                                               VspDhcpDomainOption vspDhcpOptions)
                                                        throws NuageVspException

Throws:

NuageVspException

createDhcpOptions

void createDhcpOptions(NuageVspApiClient.ExistingDhcpOptionStrategy existingOptionStrategy,
                       NetworkDetails attachedNetworkDetails,
                       VspNetwork vspNetwork,
                       DhcpOptions dhcpOptions)
                throws NuageVspException

Depending on the option strategy new dhcp options get created on the vsd for a subnet

Parameters:

existingOptionStrategy - FETCH, FETCH_AND_DELETE, IGNORE

attachedNetworkDetails -

vspNetwork -

dhcpOptions -

Throws:

NuageVspException

createDhcpOptions

void createDhcpOptions(NuageVspApiClient.ExistingDhcpOptionStrategy existingOptionStrategy,
                       NuageVspEntity nuageVspEntity,
                       String nuageVspEntityUuid,
                       String nuageVspEntityId,
                       VspNetwork vspNetwork,
                       DhcpOptions dhcpOptions)
                throws NuageVspException

Depending on the option strategy new dhcp options get created on the vsd for the specified vsd entity (vport or subnet)

Parameters:

existingOptionStrategy -

nuageVspEntity -

nuageVspEntityUuid -

nuageVspEntityId -

vspNetwork -

dhcpOptions -

Throws:

NuageVspException

removeAllDhcpOptionsWithCode

void removeAllDhcpOptionsWithCode(NuageVspEntity nuageVspEntity,
                                  String externalUuid,
                                  String entityId,
                                  Set<Integer> dhcpOptionCodesToRemove)
                           throws NuageVspException

Removes all specified dhcp options from the specified nic.

Parameters:

nuageVspEntity -

externalUuid -

entityId -

dhcpOptionCodesToRemove -

Throws:

NuageVspException

findIsolatedL3Network

VspNetwork findIsolatedL3Network(VspNetwork vspNetwork)

createIsolatedL2NetworkWithDefaultACLs

NetworkRelatedVsdIds createIsolatedL2NetworkWithDefaultACLs(VspNetwork vspNetwork)
                                                     throws NuageVspException

Throws:

NuageVspException

getEnterprise

String getEnterprise(String domainUuid)
              throws NuageVspException

Throws:

NuageVspException

getIsolatedSubNetwork

Pair<String,String> getIsolatedSubNetwork(String enterpriseId,
                                          VspNetwork vspNetwork)
                                   throws NuageVspException

Throws:

NuageVspException

getIsolatedSubNetwork

Pair<String,String> getIsolatedSubNetwork(boolean throwExceptionWhenNotFound,
                                          String enterpriseId,
                                          VspNetwork vspNetwork)
                                   throws NuageVspException

Throws:

NuageVspException

getIsolatedDomain

String getIsolatedDomain(String enterpriseId,
                         NuageVspEntity attachedNetworkType,
                         String vpcOrSubnetUuid)
                  throws NuageVspException

Throws:

NuageVspException

getIsolatedDomain

String getIsolatedDomain(boolean throwExceptionWhenNotFound,
                         String enterpriseId,
                         NuageVspEntity attachedNetworkType,
                         String vpcOrSubnetUuid)
                  throws NuageVspException

Throws:

NuageVspException

allocateFIPToVPortInVsp

String allocateFIPToVPortInVsp(NetworkDetails attachedNetworkDetails,
                               String vportId,
                               String vspSharedNetworkId,
                               String staticNatIp,
                               String staticNatIpUuid,
                               String nicSecondaryIp4Address,
                               String nicSecondaryIpUuid)
                        throws NuageVspException

Throws:

NuageVspException

updateVPortWithFloatingIPId

void updateVPortWithFloatingIPId(String vportId,
                                 String floatingIPId)
                          throws NuageVspException

Throws:

NuageVspException

releaseFIPFromVsp

void releaseFIPFromVsp(NetworkDetails attachedNetworkDetails,
                       String vportId,
                       String staticNatIpUuid,
                       String nicSecondaryIpUuid)
                throws NuageVspException

Throws:

NuageVspException

findEntityUsingFilter

String findEntityUsingFilter(NuageVspEntity entityType,
                             String entityId,
                             NuageVspEntity childEntityType,
                             NuageVspFilter filter)
                      throws NuageVspException

Throws:

NuageVspException

getEnterpriseName

String getEnterpriseName(String domainName,
                         String domainPath)

getResources

String getResources(NuageVspEntity entityType)
             throws NuageVspException

Throws:

NuageVspException

getResources

<T> T getResources(NuageVspEntity entityType,
                   Class<T> type)
            throws NuageVspException

Throws:

NuageVspException

findEntityUsingFilter

String findEntityUsingFilter(NuageVspEntity entityType,
                             String entityId,
                             NuageVspEntity childEntityType,
                             NuageVspAttribute filterAttr,
                             Object filterAttrValue)
                      throws NuageVspException

Throws:

NuageVspException

findEntityIdByExternalUuid

String findEntityIdByExternalUuid(NuageVspEntity entityType,
                                  String entityId,
                                  NuageVspEntity childEntityType,
                                  String externalId)
                           throws NuageVspException

Throws:

NuageVspException

findFieldValueByExternalUuid

<T> T findFieldValueByExternalUuid(NuageVspEntity entityType,
                                   String entityId,
                                   NuageVspEntity childEntityType,
                                   String externalId,
                                   NuageVspAttribute fieldName)
                            throws NuageVspException

Throws:

NuageVspException

findEntityByExternalUuid

String findEntityByExternalUuid(NuageVspEntity entityType,
                                String entityId,
                                NuageVspEntity childEntityType,
                                String externalId)
                         throws NuageVspException

Throws:

NuageVspException

getEntityId

String getEntityId(String jsonString,
                   NuageVspEntity entityType)
            throws NuageVspException

Throws:

NuageVspException

cleanUpDomainAndTemplate

void cleanUpDomainAndTemplate(String enterpriseId,
                              String networkUuid,
                              String domainTemplateName)
                       throws NuageVspException

Throws:

NuageVspException

createVportInVsp

void createVportInVsp(VspNic vspNic,
                      VspNetwork vspNetwork,
                      List<NuageVspObject> vmInterfaceList,
                      NetworkDetails attachedNetworkDetails,
                      DhcpOptions dhcpOptions)
               throws NuageVspException

Throws:

NuageVspException

generateCmsIdForNuageVsp

String generateCmsIdForNuageVsp(String cmsName)
                         throws NuageVspException

Throws:

NuageVspException

removeCmsIdForNuageVsp

boolean removeCmsIdForNuageVsp(String cmsId)
                        throws NuageVspException

Throws:

NuageVspException

isKnownCmsIdForNuageVsp

boolean isKnownCmsIdForNuageVsp(String cmsId)
                         throws NuageVspException

Throws:

NuageVspException

parseJsonString

List<NuageVspObject> parseJsonString(NuageVspEntity entity,
                                     String json)
                              throws NuageVspException

Throws:

NuageVspException

parseJsonString

<T> T parseJsonString(NuageVspEntity entity,
                      String json,
                      Class<T> type)
               throws NuageVspException

Throws:

NuageVspException

deleteQuietly

void deleteQuietly(NuageVspEntity entityType,
                   String entityId)

getResources

String getResources(NuageVspEntity enterprise,
                    NuageVspFilter filter)
             throws NuageVspApiException

Throws:

NuageVspApiException

getResources

String getResources(NuageVspObject parent,
                    NuageVspEntity childEntityType)
             throws NuageVspApiException

Throws:

NuageVspApiException