com.huawei.openstack4j.api.tacker.VimService Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2016 ContainX and OpenStack4j
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not
* use this file except in compliance with the License. You may obtain a copy of
* the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations under
* the License.
*******************************************************************************/
package com.huawei.openstack4j.api.tacker;
import java.util.List;
import java.util.Map;
import com.huawei.openstack4j.common.RestService;
import com.huawei.openstack4j.model.common.ActionResponse;
import com.huawei.openstack4j.model.tacker.Vim;
/**
* Tacker - OpenStack NFV Orchestration
*
* Tacker is an official OpenStack project building a Generic VIM Manager (VIMM) and a NFV Orchestrator (NFVO) to deploy and operate
* Network Services and Virtual Network Functions (VIMs) on an NFV infrastructure platform like OpenStack.
* It is based on ETSI MANO Architectural Framework and provides a functional stack to Orchestrate Network Services end-to-end using VIMs.
*
*
* NFVO:
*
* - Templatized end-to-end Network Service deployment using decomposed VIMs.
* - VIM placement policy – ensure efficient placement of VIMs.
* - VIMs connected using an SFC - described in a VIM Forwarding Graph Descriptor.
* - VIM Resource Checks and Resource Allocation.
* - Ability to orchestrate VIMs across Multiple VIMs and Multiple Sites (POPs).
*
*
*
* @see Official Tacker Documentation
* @see Official GitHub Tacker Reference
*
* @author Vishvesh Deshmukh
* @date Aug 18, 2016
*/
public interface VimService extends RestService {
/**
* List vims - Lists instantiated vims in VIM Manager
*
* @return list of all Vim(s)
*/
List list();
/**
* List vims - Lists instantiated vims in VIM Manager filtered by parameters.
*
* @param filteringParams map (name, value) of filtering parameters
* @return filtered list of Vim(s)
*/
List list(Map filteringParams);
/**
* Show Vim - Show information for a specified vimId.
*
* @param vimId the Vim identifier
* @return the Vim or null if not found
*/
Vim show(String vimId);
/**
* Delete Vim - Deletes a specified vimId from the VIM catalog.
* @param vimId the Vim identifier
* @return the action response
*/
ActionResponse delete(String vimId);
/**
* Create Vim - Register a Vim entry based on the Vim template.
* @param Vim
* @return Vim
*/
Vim register(Vim vim);
/**
* Update vim - Update a vim based on user config file or data.
* @param vimId the Vim identifier
* @param vimUpdate VimUpdate
* @return Vim
*/
//Vim update(String vimId, VimUpdate vimUpdate);
}