com.huawei.openstack4j.api.tacker.VnfService 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.Vnf;
import com.huawei.openstack4j.model.tacker.VnfUpdate;

/**
 * Tacker - OpenStack NFV Orchestration
 * 
 * Tacker is an official OpenStack project building a Generic VNF Manager (VNFM) and a NFV Orchestrator (NFVO) to deploy and operate 
 * Network Services and Virtual Network Functions (VNFs) 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 VNFs.
 * 
 * Vnf Stands for Virtual Network Functions. This is the VNF Management API Service which is used to Deploy VNFs..
 * 
 * 
	 * VNFM:
	 * 

	 * 		Basic life-cycle of VNF (create/update/delete).
	 * 		Enhanced platform-aware (EPA) placement of high-performance NFV workloads.
	 * 		Health monitoring of deployed VNFs.
	 * 		Auto Healing / Auto Scaling VNFs based on Policy.
	 * 		Facilitate initial configuration of VNF.
	 * 
 * 
 * 
 * @see Official Tacker Documentation
 * @see Official GitHub Tacker Reference
 * 
 * @author Vishvesh Deshmukh
 * @date Aug 11, 2016
 */
public interface VnfService extends RestService {
	
	/**
     * List vnfs - Lists instantiated vnfs in VNF Manager
     *
     * @return list of all Vnf(s)
     */
    List list();
    
    /**
     * List vnfs - Lists instantiated vnfs in VNF Manager filtered by parameters.
     * 
     * @param filteringParams map (name, value) of filtering parameters
     * @return filtered list of Vnf(s)
     */
    List list(Map filteringParams);
    
    /**
     * Show Vnf - Show information for a specified VnfId.
     *
     * @param VnfId the Vnf identifier
     * @return the Vnf or null if not found
     */
    Vnf get(String vnfId);
    
    /**
     * Delete Vnf - Deletes a specified VnfId from the VNF catalog.
     * @param VnfId the Vnf identifier
     * @return the action response
     */
    ActionResponse delete(String vnfId);
    
    /**
     * Create Vnf - Create a Vnf entry based on the Vnf template.
     * @param Vnf 
     * @return Vnf
     */
    Vnf create(Vnf vnf);
    
    /**
     * Update vnf - Update a vnf based on user config file or data.
     * @param vnfId the Vnf identifier
     * @param vnfUpdate VnfUpdate
     * @return Vnf
     */
    Vnf update(String vnfId, VnfUpdate vnfUpdate);

}