815 lines
32 KiB
Python
815 lines
32 KiB
Python
# vim: tabstop=4 shiftwidth=4 softtabstop=4
|
|
#
|
|
# Copyright 2013 VMware, Inc
|
|
#
|
|
# 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.
|
|
|
|
from oslo_config import cfg
|
|
from oslo_log import log as logging
|
|
from oslo_serialization import jsonutils
|
|
import retrying
|
|
import six
|
|
import xml.etree.ElementTree as et
|
|
|
|
from vmware_nsx.plugins.nsx_v.vshield.common import exceptions
|
|
from vmware_nsx.plugins.nsx_v.vshield.common import VcnsApiClient
|
|
|
|
LOG = logging.getLogger(__name__)
|
|
|
|
HTTP_GET = "GET"
|
|
HTTP_POST = "POST"
|
|
HTTP_DELETE = "DELETE"
|
|
HTTP_PUT = "PUT"
|
|
URI_PREFIX = "/api/4.0/edges"
|
|
|
|
#FwaaS constants
|
|
FIREWALL_SERVICE = "firewall/config"
|
|
FIREWALL_RULE_RESOURCE = "rules"
|
|
|
|
#NSXv Constants
|
|
FIREWALL_PREFIX = '/api/4.0/firewall/globalroot-0/config'
|
|
SECURITYGROUP_PREFIX = '/api/2.0/services/securitygroup'
|
|
VDN_PREFIX = '/api/2.0/vdn'
|
|
SERVICES_PREFIX = '/api/2.0/services'
|
|
SPOOFGUARD_PREFIX = '/api/4.0/services/spoofguard'
|
|
|
|
#LbaaS Constants
|
|
LOADBALANCER_SERVICE = "loadbalancer/config"
|
|
LOADBALANCER_STATS = "loadbalancer/statistics"
|
|
VIP_RESOURCE = "virtualservers"
|
|
POOL_RESOURCE = "pools"
|
|
MONITOR_RESOURCE = "monitors"
|
|
APP_PROFILE_RESOURCE = "applicationprofiles"
|
|
APP_RULE_RESOURCE = "applicationrules"
|
|
|
|
# IPsec VPNaaS Constants
|
|
IPSEC_VPN_SERVICE = 'ipsec/config'
|
|
|
|
# Dhcp constants
|
|
DHCP_SERVICE = "dhcp/config"
|
|
DHCP_BINDING_RESOURCE = "bindings"
|
|
|
|
# Syetem control constants
|
|
SYSCTL_SERVICE = 'systemcontrol/config'
|
|
|
|
# L2 gateway constants
|
|
BRIDGE = "bridging/config"
|
|
|
|
|
|
def retry_upon_exception(exc, delay=500, max_delay=2000,
|
|
max_attempts=cfg.CONF.nsxv.retries):
|
|
return retrying.retry(retry_on_exception=lambda e: isinstance(e, exc),
|
|
wait_exponential_multiplier=delay,
|
|
wait_exponential_max=max_delay,
|
|
stop_max_attempt_number=max_attempts)
|
|
|
|
|
|
class Vcns(object):
|
|
|
|
def __init__(self, address, user, password, ca_file, insecure):
|
|
self.address = address
|
|
self.user = user
|
|
self.password = password
|
|
self.ca_file = ca_file
|
|
self.insecure = insecure
|
|
self.jsonapi_client = VcnsApiClient.VcnsApiHelper(address, user,
|
|
password,
|
|
format='json',
|
|
ca_file=ca_file,
|
|
insecure=insecure)
|
|
self.xmlapi_client = VcnsApiClient.VcnsApiHelper(address, user,
|
|
password,
|
|
format='xml',
|
|
ca_file=ca_file,
|
|
insecure=insecure)
|
|
|
|
@retry_upon_exception(exceptions.ServiceConflict)
|
|
def _client_request(self, client, method, uri,
|
|
params, headers, encodeParams):
|
|
return client(method, uri, params, headers, encodeParams)
|
|
|
|
def do_request(self, method, uri, params=None, format='json', **kwargs):
|
|
LOG.debug("VcnsApiHelper('%(method)s', '%(uri)s', '%(body)s')", {
|
|
'method': method,
|
|
'uri': uri,
|
|
'body': jsonutils.dumps(params)})
|
|
headers = kwargs.get('headers')
|
|
encodeParams = kwargs.get('encode', True)
|
|
if format == 'json':
|
|
_client = self.jsonapi_client.request
|
|
else:
|
|
_client = self.xmlapi_client.request
|
|
header, content = self._client_request(_client, method, uri, params,
|
|
headers, encodeParams)
|
|
|
|
LOG.debug('VcnsApiHelper reply: header=%(header)s content=%(content)s',
|
|
{'header': header, 'content': content})
|
|
if content == '':
|
|
return header, {}
|
|
if kwargs.get('decode', True):
|
|
content = jsonutils.loads(content)
|
|
return header, content
|
|
|
|
def edges_lock_operation(self):
|
|
uri = URI_PREFIX + "?lockUpdatesOnEdge=true"
|
|
return self.do_request(HTTP_POST, uri, decode=False)
|
|
|
|
def deploy_edge(self, request, async=True):
|
|
uri = URI_PREFIX
|
|
if async:
|
|
uri += "?async=true"
|
|
return self.do_request(HTTP_POST, uri, request, decode=False)
|
|
|
|
def update_edge(self, edge_id, request, async=False):
|
|
uri = "%s/%s" % (URI_PREFIX, edge_id)
|
|
if async:
|
|
uri += "?async=true"
|
|
return self.do_request(HTTP_PUT, uri, request, decode=False)
|
|
|
|
def get_edge_id(self, job_id):
|
|
uri = URI_PREFIX + "/jobs/%s" % job_id
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def get_edge_jobs(self, edge_id):
|
|
uri = URI_PREFIX + "/%s/jobs" % edge_id
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def get_edge_deploy_status(self, edge_id):
|
|
uri = URI_PREFIX + "/%s/status?getlatest=false" % edge_id
|
|
return self.do_request(HTTP_GET, uri, decode="True")
|
|
|
|
def delete_edge(self, edge_id):
|
|
uri = "%s/%s" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def add_vdr_internal_interface(self, edge_id, interface):
|
|
uri = "%s/%s/interfaces?action=patch" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_POST, uri, interface, decode=True)
|
|
|
|
def update_vdr_internal_interface(self, edge_id,
|
|
interface_index, interface):
|
|
uri = "%s/%s/interfaces/%s" % (URI_PREFIX, edge_id, interface_index)
|
|
return self.do_request(HTTP_PUT, uri, interface,
|
|
format='xml', decode=True)
|
|
|
|
def delete_vdr_internal_interface(self, edge_id, interface_index):
|
|
uri = "%s/%s/interfaces/%d" % (URI_PREFIX, edge_id, interface_index)
|
|
return self.do_request(HTTP_DELETE, uri, decode=True)
|
|
|
|
def get_interfaces(self, edge_id):
|
|
uri = "%s/%s/vnics" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def update_interface(self, edge_id, vnic):
|
|
uri = "%s/%s/vnics/%d" % (URI_PREFIX, edge_id,
|
|
vnic['index'])
|
|
return self.do_request(HTTP_PUT, uri, vnic, decode=True)
|
|
|
|
def delete_interface(self, edge_id, vnic_index):
|
|
uri = "%s/%s/vnics/%d?async=true" % (URI_PREFIX, edge_id, vnic_index)
|
|
return self.do_request(HTTP_DELETE, uri, decode=True)
|
|
|
|
def get_nat_config(self, edge_id):
|
|
uri = "%s/%s/nat/config" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def update_nat_config(self, edge_id, nat):
|
|
uri = "%s/%s/nat/config?async=true" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_PUT, uri, nat, decode=True)
|
|
|
|
def delete_nat_rule(self, edge_id, rule_id):
|
|
uri = "%s/%s/nat/config/rules/%s" % (URI_PREFIX, edge_id, rule_id)
|
|
return self.do_request(HTTP_DELETE, uri, decode=True)
|
|
|
|
def get_edge_status(self, edge_id):
|
|
uri = "%s/%s/status?getlatest=false" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def get_edges(self):
|
|
uri = URI_PREFIX
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def get_edge_interfaces(self, edge_id):
|
|
uri = "%s/%s/interfaces" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def get_routes(self, edge_id):
|
|
uri = "%s/%s/routing/config/static" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_GET, uri)
|
|
|
|
def update_routes(self, edge_id, routes):
|
|
uri = "%s/%s/routing/config/static?async=true" % (URI_PREFIX, edge_id)
|
|
return self.do_request(HTTP_PUT, uri, routes)
|
|
|
|
def create_lswitch(self, lsconfig):
|
|
uri = "/api/ws.v1/lswitch"
|
|
return self.do_request(HTTP_POST, uri, lsconfig, decode=True)
|
|
|
|
def delete_lswitch(self, lswitch_id):
|
|
uri = "/api/ws.v1/lswitch/%s" % lswitch_id
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def get_loadbalancer_config(self, edge_id):
|
|
uri = self._build_uri_path(edge_id, LOADBALANCER_SERVICE)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def get_loadbalancer_statistics(self, edge_id):
|
|
uri = self._build_uri_path(edge_id, LOADBALANCER_STATS)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def enable_service_loadbalancer(self, edge_id, config):
|
|
uri = self._build_uri_path(edge_id, LOADBALANCER_SERVICE)
|
|
return self.do_request(HTTP_PUT, uri, config)
|
|
|
|
def update_firewall(self, edge_id, fw_req):
|
|
uri = self._build_uri_path(
|
|
edge_id, FIREWALL_SERVICE)
|
|
uri += '?async=true'
|
|
return self.do_request(HTTP_PUT, uri, fw_req)
|
|
|
|
def delete_firewall(self, edge_id):
|
|
uri = self._build_uri_path(
|
|
edge_id, FIREWALL_SERVICE, None)
|
|
uri += '?async=true'
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def update_firewall_rule(self, edge_id, vcns_rule_id, fwr_req):
|
|
uri = self._build_uri_path(
|
|
edge_id, FIREWALL_SERVICE,
|
|
FIREWALL_RULE_RESOURCE,
|
|
vcns_rule_id)
|
|
return self.do_request(HTTP_PUT, uri, fwr_req)
|
|
|
|
def delete_firewall_rule(self, edge_id, vcns_rule_id):
|
|
uri = self._build_uri_path(
|
|
edge_id, FIREWALL_SERVICE,
|
|
FIREWALL_RULE_RESOURCE,
|
|
vcns_rule_id)
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def add_firewall_rule_above(self, edge_id, ref_vcns_rule_id, fwr_req):
|
|
uri = self._build_uri_path(
|
|
edge_id, FIREWALL_SERVICE,
|
|
FIREWALL_RULE_RESOURCE)
|
|
uri += "?aboveRuleId=" + ref_vcns_rule_id
|
|
return self.do_request(HTTP_POST, uri, fwr_req)
|
|
|
|
def add_firewall_rule(self, edge_id, fwr_req):
|
|
uri = self._build_uri_path(
|
|
edge_id, FIREWALL_SERVICE,
|
|
FIREWALL_RULE_RESOURCE)
|
|
return self.do_request(HTTP_POST, uri, fwr_req)
|
|
|
|
def get_firewall(self, edge_id):
|
|
uri = self._build_uri_path(edge_id, FIREWALL_SERVICE)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def get_firewall_rule(self, edge_id, vcns_rule_id):
|
|
uri = self._build_uri_path(
|
|
edge_id, FIREWALL_SERVICE,
|
|
FIREWALL_RULE_RESOURCE,
|
|
vcns_rule_id)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
#
|
|
#Edge LBAAS call helper
|
|
#
|
|
def create_vip(self, edge_id, vip_new):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
VIP_RESOURCE)
|
|
return self.do_request(HTTP_POST, uri, vip_new)
|
|
|
|
def get_vip(self, edge_id, vip_vseid):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
VIP_RESOURCE, vip_vseid)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def update_vip(self, edge_id, vip_vseid, vip_new):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
VIP_RESOURCE, vip_vseid)
|
|
return self.do_request(HTTP_PUT, uri, vip_new)
|
|
|
|
def delete_vip(self, edge_id, vip_vseid):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
VIP_RESOURCE, vip_vseid)
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def create_pool(self, edge_id, pool_new):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
POOL_RESOURCE)
|
|
return self.do_request(HTTP_POST, uri, pool_new)
|
|
|
|
def get_pool(self, edge_id, pool_vseid):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
POOL_RESOURCE, pool_vseid)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def update_pool(self, edge_id, pool_vseid, pool_new):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
POOL_RESOURCE, pool_vseid)
|
|
return self.do_request(HTTP_PUT, uri, pool_new)
|
|
|
|
def delete_pool(self, edge_id, pool_vseid):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
POOL_RESOURCE, pool_vseid)
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def create_health_monitor(self, edge_id, monitor_new):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
MONITOR_RESOURCE)
|
|
return self.do_request(HTTP_POST, uri, monitor_new)
|
|
|
|
def get_health_monitor(self, edge_id, monitor_vseid):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
MONITOR_RESOURCE, monitor_vseid)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def update_health_monitor(self, edge_id, monitor_vseid, monitor_new):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
MONITOR_RESOURCE,
|
|
monitor_vseid)
|
|
return self.do_request(HTTP_PUT, uri, monitor_new)
|
|
|
|
def delete_health_monitor(self, edge_id, monitor_vseid):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
MONITOR_RESOURCE,
|
|
monitor_vseid)
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def create_app_profile(self, edge_id, app_profile):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
APP_PROFILE_RESOURCE)
|
|
return self.do_request(HTTP_POST, uri, app_profile)
|
|
|
|
def update_app_profile(self, edge_id, app_profileid, app_profile):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
APP_PROFILE_RESOURCE, app_profileid)
|
|
return self.do_request(HTTP_PUT, uri, app_profile)
|
|
|
|
def delete_app_profile(self, edge_id, app_profileid):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
APP_PROFILE_RESOURCE,
|
|
app_profileid)
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def create_app_rule(self, edge_id, app_rule):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
APP_RULE_RESOURCE)
|
|
return self.do_request(HTTP_POST, uri, app_rule)
|
|
|
|
def update_app_rule(self, edge_id, app_ruleid, app_rule):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
APP_RULE_RESOURCE, app_ruleid)
|
|
return self.do_request(HTTP_PUT, uri, app_rule)
|
|
|
|
def delete_app_rule(self, edge_id, app_ruleid):
|
|
uri = self._build_uri_path(
|
|
edge_id, LOADBALANCER_SERVICE,
|
|
APP_RULE_RESOURCE,
|
|
app_ruleid)
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def update_ipsec_config(self, edge_id, ipsec_config):
|
|
uri = self._build_uri_path(edge_id, IPSEC_VPN_SERVICE)
|
|
return self.do_request(HTTP_PUT, uri, ipsec_config)
|
|
|
|
def delete_ipsec_config(self, edge_id):
|
|
uri = self._build_uri_path(edge_id, IPSEC_VPN_SERVICE)
|
|
return self.do_request(HTTP_DELETE, uri)
|
|
|
|
def get_ipsec_config(self, edge_id):
|
|
uri = self._build_uri_path(edge_id, IPSEC_VPN_SERVICE)
|
|
return self.do_request(HTTP_GET, uri)
|
|
|
|
def create_virtual_wire(self, vdn_scope_id, request):
|
|
"""Creates a VXLAN virtual wire
|
|
|
|
The method will return the virtual wire ID.
|
|
"""
|
|
uri = '/api/2.0/vdn/scopes/%s/virtualwires' % vdn_scope_id
|
|
return self.do_request(HTTP_POST, uri, request, format='xml',
|
|
decode=False)
|
|
|
|
def delete_virtual_wire(self, virtualwire_id):
|
|
"""Deletes a virtual wire."""
|
|
uri = '/api/2.0/vdn/virtualwires/%s' % virtualwire_id
|
|
return self.do_request(HTTP_DELETE, uri, format='xml')
|
|
|
|
def create_port_group(self, dvs_id, request):
|
|
"""Creates a port group on a DVS
|
|
|
|
The method will return the port group ID.
|
|
"""
|
|
uri = '/api/2.0/xvs/switches/%s/networks' % dvs_id
|
|
return self.do_request(HTTP_POST, uri, request, format='xml',
|
|
decode=False)
|
|
|
|
def delete_port_group(self, dvs_id, portgroup_id):
|
|
"""Deletes a portgroup."""
|
|
uri = '/api/2.0/xvs/switches/%s/networks/%s' % (dvs_id,
|
|
portgroup_id)
|
|
return self.do_request(HTTP_DELETE, uri, format='xml', decode=False)
|
|
|
|
def query_interface(self, edge_id, vnic_index):
|
|
uri = "%s/%s/vnics/%d" % (URI_PREFIX, edge_id, vnic_index)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def reconfigure_dhcp_service(self, edge_id, request_config):
|
|
"""Reconfigure dhcp static bindings in the created Edge."""
|
|
uri = "/api/4.0/edges/%s/dhcp/config?async=true" % edge_id
|
|
|
|
return self.do_request(HTTP_PUT, uri, request_config)
|
|
|
|
def query_dhcp_configuration(self, edge_id):
|
|
"""Query DHCP configuration from the specific edge."""
|
|
uri = "/api/4.0/edges/%s/dhcp/config" % edge_id
|
|
return self.do_request(HTTP_GET, uri)
|
|
|
|
def create_dhcp_binding(self, edge_id, request_config):
|
|
"""Append one dhcp static binding on the edge."""
|
|
uri = self._build_uri_path(edge_id,
|
|
DHCP_SERVICE, DHCP_BINDING_RESOURCE)
|
|
return self.do_request(HTTP_POST, uri, request_config, decode=False)
|
|
|
|
def delete_dhcp_binding(self, edge_id, binding_id):
|
|
"""Delete one dhcp static binding on the edge."""
|
|
uri = self._build_uri_path(edge_id,
|
|
DHCP_SERVICE, DHCP_BINDING_RESOURCE,
|
|
binding_id)
|
|
return self.do_request(HTTP_DELETE, uri, decode=False)
|
|
|
|
def create_security_group(self, request):
|
|
"""Creates a security group container in nsx.
|
|
|
|
The method will return the security group ID.
|
|
"""
|
|
uri = '%s/globalroot-0' % (SECURITYGROUP_PREFIX)
|
|
return self.do_request(HTTP_POST, uri, request, format='xml',
|
|
decode=False)
|
|
|
|
def delete_security_group(self, securitygroup_id):
|
|
"""Deletes a security group container."""
|
|
uri = '%s/%s?force=true' % (SECURITYGROUP_PREFIX, securitygroup_id)
|
|
return self.do_request(HTTP_DELETE, uri, format='xml', decode=False)
|
|
|
|
def update_security_group(self, sg_id, sg_name, description):
|
|
"""Updates the NSXv security group name."""
|
|
uri = '%s/%s' % (SECURITYGROUP_PREFIX, sg_id)
|
|
h, c = self.do_request(HTTP_GET, uri, format='xml', decode=False)
|
|
sg = et.fromstring(c)
|
|
sg.find('name').text = sg_name
|
|
sg.find('description').text = description
|
|
return self.do_request(HTTP_PUT, uri, et.tostring(sg),
|
|
format='xml', decode=False, encode=False)
|
|
|
|
def get_security_group_id(self, sg_name):
|
|
"""Returns NSXv security group id which match the given name."""
|
|
uri = '%s/scope/globalroot-0' % SECURITYGROUP_PREFIX
|
|
h, c = self.do_request(HTTP_GET, uri, format='xml', decode=False)
|
|
root = et.fromstring(c)
|
|
for sg in root.iter('securitygroup'):
|
|
if sg.find('name').text == sg_name:
|
|
return sg.find('objectId').text
|
|
|
|
@retry_upon_exception(exceptions.VcnsApiException)
|
|
def create_bridge(self, edge_id, request):
|
|
"""Create a bridge."""
|
|
uri = self._build_uri_path(edge_id, BRIDGE)
|
|
return self.do_request(HTTP_PUT, uri, request, format='xml',
|
|
decode=False)
|
|
|
|
@retry_upon_exception(exceptions.VcnsApiException)
|
|
def delete_bridge(self, edge_id):
|
|
"""Delete a bridge."""
|
|
uri = self._build_uri_path(edge_id, BRIDGE)
|
|
return self.do_request(HTTP_DELETE, uri, format='xml', decode=False)
|
|
|
|
def create_section(self, type, request):
|
|
"""Creates a layer 3 or layer 2 section in nsx rule table.
|
|
|
|
The method will return the uri to newly created section.
|
|
"""
|
|
if type == 'ip':
|
|
sec_type = 'layer3sections'
|
|
else:
|
|
sec_type = 'layer2sections'
|
|
uri = '%s/%s?autoSaveDraft=false' % (FIREWALL_PREFIX, sec_type)
|
|
return self.do_request(HTTP_POST, uri, request, format='xml',
|
|
decode=False, encode=False)
|
|
|
|
def update_section(self, section_uri, request, h):
|
|
"""Replaces a section in nsx rule table."""
|
|
uri = '%s?autoSaveDraft=false' % section_uri
|
|
headers = self._get_section_header(section_uri, h)
|
|
return self.do_request(HTTP_PUT, uri, request, format='xml',
|
|
decode=False, encode=False, headers=headers)
|
|
|
|
def delete_section(self, section_uri):
|
|
"""Deletes a section in nsx rule table."""
|
|
uri = '%s?autoSaveDraft=false' % section_uri
|
|
return self.do_request(HTTP_DELETE, uri, format='xml', decode=False)
|
|
|
|
def get_section(self, section_uri):
|
|
return self.do_request(HTTP_GET, section_uri, format='xml',
|
|
decode=False)
|
|
|
|
def get_section_id(self, section_name):
|
|
"""Retrieve the id of a section from nsx."""
|
|
uri = FIREWALL_PREFIX
|
|
h, section_list = self.do_request(HTTP_GET, uri, decode=False,
|
|
format='xml')
|
|
|
|
root = et.fromstring(section_list)
|
|
|
|
for sec in root.iter('section'):
|
|
if sec.attrib['name'] == section_name:
|
|
return sec.attrib['id']
|
|
|
|
def update_section_by_id(self, id, type, request):
|
|
"""Update a section while building its uri from the id."""
|
|
if type == 'ip':
|
|
sec_type = 'layer3sections'
|
|
else:
|
|
sec_type = 'layer2sections'
|
|
section_uri = '%s/%s/%s' % (FIREWALL_PREFIX, sec_type, id)
|
|
self.update_section(section_uri, request, h=None)
|
|
|
|
def _get_section_header(self, section_uri, h=None):
|
|
if h is None:
|
|
h, c = self.do_request(HTTP_GET, section_uri, format='xml',
|
|
decode=False)
|
|
etag = h['etag']
|
|
headers = {'If-Match': etag}
|
|
return headers
|
|
|
|
def remove_rule_from_section(self, section_uri, rule_id):
|
|
"""Deletes a rule from nsx section table."""
|
|
uri = '%s/rules/%s?autoSaveDraft=false' % (section_uri, rule_id)
|
|
headers = self._get_section_header(section_uri)
|
|
return self.do_request(HTTP_DELETE, uri, format='xml',
|
|
headers=headers)
|
|
|
|
@retry_upon_exception(exceptions.RequestBad)
|
|
def add_member_to_security_group(self, security_group_id, member_id):
|
|
"""Adds a vnic member to nsx security group."""
|
|
uri = '%s/%s/members/%s?failIfExists=false' % (
|
|
SECURITYGROUP_PREFIX, security_group_id, member_id)
|
|
return self.do_request(HTTP_PUT, uri, format='xml', decode=False)
|
|
|
|
def remove_member_from_security_group(self, security_group_id,
|
|
member_id):
|
|
"""Removes a vnic member from nsx security group."""
|
|
uri = '%s/%s/members/%s?failIfAbsent=false' % (
|
|
SECURITYGROUP_PREFIX, security_group_id, member_id)
|
|
return self.do_request(HTTP_DELETE, uri, format='xml', decode=False)
|
|
|
|
def set_system_control(self, edge_id, prop):
|
|
uri = self._build_uri_path(edge_id, SYSCTL_SERVICE)
|
|
|
|
payload = {
|
|
'featureType': 'systemcontrol',
|
|
'property': prop
|
|
}
|
|
return self.do_request(HTTP_PUT, uri, payload, decode=True)
|
|
|
|
def get_system_control(self, edge_id):
|
|
uri = self._build_uri_path(edge_id, SYSCTL_SERVICE)
|
|
|
|
return self.do_request(HTTP_GET, uri)
|
|
|
|
@retry_upon_exception(exceptions.RequestBad)
|
|
def create_spoofguard_policy(self, enforcement_point, name, enable):
|
|
uri = '%s/policies/' % SPOOFGUARD_PREFIX
|
|
|
|
body = {'spoofguardPolicy':
|
|
{'name': name,
|
|
'operationMode': 'MANUAL' if enable else 'DISABLE',
|
|
'enforcementPoint':
|
|
{'id': enforcement_point,
|
|
'type': enforcement_point.split('-')[0]},
|
|
'allowLocalIPs': 'true'}}
|
|
return self.do_request(HTTP_POST, uri, body,
|
|
format='xml', encode=True, decode=False)
|
|
|
|
@retry_upon_exception(exceptions.RequestBad)
|
|
def update_spoofguard_policy(self, policy_id,
|
|
enforcement_point, name, enable):
|
|
update_uri = '%s/policies/%s' % (SPOOFGUARD_PREFIX, policy_id)
|
|
publish_uri = '%s/%s?action=publish' % (SPOOFGUARD_PREFIX, policy_id)
|
|
|
|
body = {'spoofguardPolicy':
|
|
{'policyId': policy_id,
|
|
'name': name,
|
|
'operationMode': 'MANUAL' if enable else 'DISABLE',
|
|
'enforcementPoint':
|
|
{'id': enforcement_point,
|
|
'type': enforcement_point.split('-')[0]},
|
|
'allowLocalIPs': 'true'}}
|
|
|
|
self.do_request(HTTP_PUT, update_uri, body,
|
|
format='xml', encode=True, decode=False)
|
|
return self.do_request(HTTP_POST, publish_uri, decode=False)
|
|
|
|
@retry_upon_exception(exceptions.RequestBad)
|
|
def delete_spoofguard_policy(self, policy_id):
|
|
uri = '%s/policies/%s' % (SPOOFGUARD_PREFIX, policy_id)
|
|
return self.do_request(HTTP_DELETE, uri, decode=False)
|
|
|
|
def get_spoofguard_policy(self, policy_id):
|
|
uri = '%s/policies/%s' % (SPOOFGUARD_PREFIX, policy_id)
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def get_spoofguard_policies(self):
|
|
uri = '%s/policies/' % SPOOFGUARD_PREFIX
|
|
return self.do_request(HTTP_GET, uri, decode=True)
|
|
|
|
def _approve_assigned_addresses(self, policy_id,
|
|
vnic_id, mac_addr, addresses):
|
|
uri = '%s/%s' % (SPOOFGUARD_PREFIX, policy_id)
|
|
addresses = [{'ipAddress': ip_addr} for ip_addr in addresses]
|
|
body = {'spoofguardList':
|
|
{'spoofguard':
|
|
{'id': vnic_id,
|
|
'vnicUuid': vnic_id,
|
|
'approvedIpAddress': addresses,
|
|
'approvedMacAddress': mac_addr,
|
|
'publishedIpAddress': addresses,
|
|
'publishedMacAddress': mac_addr}}}
|
|
|
|
return self.do_request(HTTP_POST, '%s?action=approve' % uri,
|
|
body, format='xml', decode=False)
|
|
|
|
@retry_upon_exception(exceptions.RequestBad)
|
|
def approve_assigned_addresses(self, policy_id,
|
|
vnic_id, mac_addr, addresses):
|
|
return self._approve_assigned_addresses(
|
|
policy_id, vnic_id, mac_addr, addresses)
|
|
|
|
@retry_upon_exception(exceptions.VcnsApiException)
|
|
def publish_assigned_addresses(self, policy_id, vnic_id):
|
|
uri = '%s/%s' % (SPOOFGUARD_PREFIX, policy_id)
|
|
publish_vnic_uri = '%s?action=publish&vnicId=%s' % (uri, vnic_id)
|
|
return self.do_request(HTTP_POST, publish_vnic_uri, decode=False)
|
|
|
|
def inactivate_vnic_assigned_addresses(self, policy_id, vnic_id):
|
|
try:
|
|
self._approve_assigned_addresses(policy_id, vnic_id, '', [])
|
|
except exceptions.RequestBad:
|
|
LOG.debug("Request failed: inactivate vnic %s assigned addresses",
|
|
vnic_id)
|
|
else:
|
|
return self.publish_assigned_addresses(policy_id, vnic_id)
|
|
|
|
def _build_uri_path(self, edge_id,
|
|
service,
|
|
resource=None,
|
|
resource_id=None,
|
|
parent_resource_id=None,
|
|
fields=None,
|
|
relations=None,
|
|
filters=None,
|
|
types=None,
|
|
is_attachment=False,
|
|
is_async=False):
|
|
uri_prefix = "%s/%s/%s" % (URI_PREFIX, edge_id, service)
|
|
if resource:
|
|
res_path = resource + (resource_id and "/%s" % resource_id or '')
|
|
uri_path = "%s/%s" % (uri_prefix, res_path)
|
|
else:
|
|
uri_path = uri_prefix
|
|
if is_async:
|
|
return (uri_path + "?async=true")
|
|
else:
|
|
return uri_path
|
|
|
|
def _scopingobjects_lookup(self, type_name, object_id, name=None):
|
|
uri = '%s/usermgmt/scopingobjects' % SERVICES_PREFIX
|
|
h, so_list = self.do_request(HTTP_GET, uri, decode=False,
|
|
format='xml')
|
|
|
|
root = et.fromstring(so_list)
|
|
for obj in root.iter('object'):
|
|
if (obj.find('objectTypeName').text == type_name and
|
|
obj.find('objectId').text == object_id and
|
|
(name is None or obj.find('name').text == name)):
|
|
return True
|
|
|
|
return False
|
|
|
|
def validate_datacenter_moid(self, object_id):
|
|
return self._scopingobjects_lookup('Datacenter', object_id)
|
|
|
|
def validate_network(self, object_id):
|
|
return (self._scopingobjects_lookup('Network', object_id) or
|
|
self._scopingobjects_lookup('DistributedVirtualPortgroup',
|
|
object_id) or
|
|
self._scopingobjects_lookup('VirtualWire', object_id))
|
|
|
|
def validate_network_name(self, object_id, name):
|
|
return (self._scopingobjects_lookup('Network', object_id, name) or
|
|
self._scopingobjects_lookup('DistributedVirtualPortgroup',
|
|
object_id, name) or
|
|
self._scopingobjects_lookup('VirtualWire', object_id, name))
|
|
|
|
def validate_vdn_scope(self, object_id):
|
|
uri = '%s/scopes' % VDN_PREFIX
|
|
h, scope_list = self.do_request(HTTP_GET, uri, decode=False,
|
|
format='xml')
|
|
|
|
root = et.fromstring(scope_list)
|
|
for obj_id in root.iter('objectId'):
|
|
if obj_id.text == object_id:
|
|
return True
|
|
|
|
return False
|
|
|
|
def validate_dvs(self, object_id):
|
|
uri = '%s/switches' % VDN_PREFIX
|
|
h, dvs_list = self.do_request(HTTP_GET, uri, decode=False,
|
|
format='xml')
|
|
|
|
root = et.fromstring(dvs_list)
|
|
for obj_id in root.iter('objectId'):
|
|
if obj_id.text == object_id:
|
|
return True
|
|
|
|
return False
|
|
|
|
def validate_inventory(self, object_id):
|
|
uri = '%s/inventory/%s/basicinfo' % (SERVICES_PREFIX, object_id)
|
|
try:
|
|
h, c = self.do_request(HTTP_GET, uri, decode=False)
|
|
except exceptions.ResourceNotFound:
|
|
return False
|
|
return True
|
|
|
|
def get_version(self):
|
|
uri = '/api/1.0/appliance-management/summary/system'
|
|
h, c = self.do_request(HTTP_GET, uri, decode=True)
|
|
version = '%s.%s.%s' % (c['versionInfo']['majorVersion'],
|
|
c['versionInfo']['minorVersion'],
|
|
c['versionInfo']['patchVersion'])
|
|
LOG.debug("NSX Version: %s, Build: %s",
|
|
version, c['versionInfo']['buildNumber'])
|
|
return version
|
|
|
|
def get_tuning_configration(self):
|
|
uri = '/api/4.0/edgePublish/tuningConfiguration'
|
|
h, c = self.do_request(HTTP_GET, uri, decode=True)
|
|
return c
|
|
|
|
def configure_aggregate_publishing(self):
|
|
uri = "/api/4.0/edgePublish/tuningConfiguration"
|
|
# Ensure that configured values are not changed
|
|
config = self.get_tuning_configration()
|
|
LOG.debug("Tuning configuration: %s", config)
|
|
tuning = et.Element('tuningConfiguration')
|
|
for opt, val in six.iteritems(config):
|
|
child = et.Element(opt)
|
|
if opt == 'aggregatePublishing':
|
|
child.text = 'true'
|
|
else:
|
|
child.text = str(val)
|
|
tuning.append(child)
|
|
return self.do_request(HTTP_PUT, uri, et.tostring(tuning),
|
|
format='xml', decode=True)
|
|
|
|
def enable_ha(self, edge_id, request_config, async=True):
|
|
"""Enable HA in the given edge."""
|
|
uri = "/api/4.0/edges/%s/highavailability/config" % edge_id
|
|
if async:
|
|
uri += "?async=true"
|
|
return self.do_request(HTTP_PUT, uri, request_config)
|
|
|
|
def upload_edge_certificate(self, edge_id, request):
|
|
"""Creates a certificate on the specified Edge appliance."""
|
|
uri = '/api/2.0/services/truststore/certificate/%s' % edge_id
|
|
return self.do_request(HTTP_POST, uri, request, decode=True)
|