aboutsummaryrefslogtreecommitdiffstats
path: root/netbox-client/provider/src/main/java/org/onap/ccsdk/sli/adaptors/netbox/api/NetboxClient.java
blob: 57d727addba377691b2ee7991160ca95ede0b4c3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/*
 * Copyright (C) 2018 Bell Canada.
 *
 * 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 org.onap.ccsdk.sli.adaptors.netbox.api;

import org.onap.ccsdk.sli.adaptors.netbox.model.IPAddress;
import org.onap.ccsdk.sli.adaptors.netbox.model.Prefix;

public interface NetboxClient {

    /**
     * Assign next available IP in prefix.
     *
     * @param prefix The prefix from which to get next available IP.
     * @return The IPAddress
     * @throws IpamException If something goes wrong.
     */
    IPAddress assign(Prefix prefix) throws IpamException;

    /**
     * Free the IP.
     *
     * @param ip The IP to release.
     * @throws IpamException If something goes wrong.
     */
    void unassign(IPAddress ip) throws IpamException;
}