The quantum.plugins.nicira.nicira_nvp_plugin.nvplib Module

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.check_cluster_connectivity(cluster)

Make sure that we can issue a request to each of the cluster nodes

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_l2_gw_service(cluster, tenant_id, display_name, devices)

Create a NVP Layer-2 Network Gateway Service.

Parameters:

• cluster – The target NVP cluster
• tenant_id – Identifier of the Openstack tenant for which

the gateway service. :param display_name: Descriptive name of this gateway service :param devices: List of transport node uuids (and network interfaces on them) to use for the network gateway service :raise NvpApiException: if there is a problem while communicating with the NVP controller

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lport(cluster, lswitch_uuid, tenant_id, quantum_port_id, display_name, device_id, admin_status_enabled, mac_address=None, fixed_ips=None, port_security_enabled=None, security_profiles=None, queue_id=None)

Creates a logical port on the assigned logical switch

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lqueue(cluster, lqueue)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter(cluster, tenant_id, display_name, nexthop)

Create a NVP logical router on the specified cluster.

Parameters:

• cluster – The target NVP cluster
• tenant_id – Identifier of the Openstack tenant for which

the logical router is being created :param display_name: Descriptive name of this logical router :param nexthop: External gateway IP address for the logical router :raise NvpApiException: if there is a problem while communicating with the NVP controller

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_dnat_rule(cluster, *args, **kwargs)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_dnat_rule_v2(cluster, router_id, dst_ip, to_dst_port=None, match_criteria=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_dnat_rule_v3(cluster, router_id, dst_ip, to_dst_port=None, order=None, match_criteria=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_nosnat_rule(cluster, *args, **kwargs)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_nosnat_rule_v2(cluster, _router_id, _match_criteria=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_nosnat_rule_v3(cluster, router_id, order=None, match_criteria=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_snat_rule(cluster, *args, **kwargs)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_snat_rule_v2(cluster, router_id, min_src_ip, max_src_ip, match_criteria=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lrouter_snat_rule_v3(cluster, router_id, min_src_ip, max_src_ip, order=None, match_criteria=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_lswitch(cluster, tenant_id, display_name, transport_type=None, transport_zone_uuid=None, vlan_id=None, quantum_net_id=None, shared=None, **kwargs)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_router_lport(cluster, lrouter_uuid, tenant_id, quantum_port_id, display_name, admin_status_enabled, ip_addresses)

Creates a logical port on the assigned logical router

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.create_security_profile(cluster, tenant_id, security_profile)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_l2_gw_service(cluster, gateway_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_lqueue(cluster, id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_lrouter(cluster, lrouter_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_nat_rules_by_match(cluster, router_id, rule_type, max_num_expected, min_num_expected=0, **kwargs)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_network(cluster, net_id, lswitch_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_networks(cluster, net_id, lswitch_ids)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_peer_router_lport(cluster, lr_uuid, ls_uuid, lp_uuid)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_port(cluster, switch, port)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_router_lport(cluster, lrouter_uuid, lport_uuid)

Creates a logical port on the assigned logical router

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_router_nat_rule(cluster, router_id, rule_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.delete_security_profile(cluster, spid)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.do_multi_request(*args, **kwargs)

Issue a request to all clusters

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.do_request(*args, **kwargs)

Convenience function wraps do_single_request.

Parameters:

• args – a list of positional arguments.
• kwargs – a list of keyworkds arguments.

Returns:

the result of do_single_request loaded into a python object or None.

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.do_single_request(*args, **kwargs)

Issue a request to a specified cluster if specified via kwargs (cluster=<cluster>).

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.find_lswitch_by_portid(clusters, port_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.find_port_and_cluster(clusters, port_id)

Return (url, cluster_id) of port or (None, None) if port does not exist.

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.find_router_gw_port(context, cluster, router_id)

Retrieves the external gateway port for a NVP logical router

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.format_exception(etype, e, execption_locals, request=None)

Consistent formatting for exceptions. :param etype: a string describing the exception type. :param e: the exception. :param request: the request object. :param execption_locals: calling context local variable dict. :returns: a formatted string.

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_all_networks(cluster, tenant_id, networks)

Append the quantum network uuids we can find in the given cluster to “networks”

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_all_query_pages(path, c)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_cluster_version(cluster)

Return major/minor version #

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_function_by_version(func_name, nvp_ver)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_gateway_services(cluster)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_l2_gw_service(cluster, gateway_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_l2_gw_services(cluster, tenant_id=None, fields=None, filters=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_lrouter(cluster, lrouter_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_lrouters(cluster, tenant_id, fields=None, filters=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_lswitches(cluster, quantum_net_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_port(cluster, network, port, relations=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_port_by_display_name(clusters, lswitch, display_name)

Return (url, cluster_id) of port or raises ResourceNotFound

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_port_by_quantum_tag(cluster, lswitch_uuid, quantum_port_id)

Return the NVP UUID of the logical port with tag q_port_id equal to quantum_port_id or None if the port is not Found.

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_port_status(cluster, lswitch_id, port_id)

Retrieve the operational status of the port

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_router_nat_rule(cluster, tenant_id, router_id, rule_id)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.get_transport_zones(cluster)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.mk_body(**kwargs)

Convenience function creates and dumps dictionary to string.

Parameters:kwargs – the key/value pirs to be dumped into a json string. Returns:a json string.

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.plug_interface(cluster, lswitch_id, port, type, attachment=None)

Plug a VIF Attachment object in a logical port

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.plug_l2_gw_service(cluster, lswitch_id, lport_id, gateway_id, vlan_id=None)

Plug a Layer-2 Gateway Attachment object in a logical port

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.plug_router_port_attachment(cluster, router_id, port_id, attachment_uuid, nvp_attachment_type, attachment_vlan=None)

Attach a router port to the given attachment. Current attachment types: - PatchAttachment [-> logical switch port uuid] - L3GatewayAttachment [-> L3GatewayService uuid] For the latter attachment type a VLAN ID can be specified as well

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.query_lrouter_lports(cluster, lr_uuid, fields='*', filters=None, relations=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.query_lswitch_lports(cluster, ls_uuid, fields='*', filters=None, relations=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.query_nat_rules(cluster, router_id, fields='*', filters=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.query_networks(cluster, tenant_id, fields='*', tags=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.set_tenant_id_tag(tenant_id, taglist=None)

Convenience function to add tenant_id tag to taglist.

Parameters:

• tenant_id – the tenant_id to set.
• taglist – the taglist to append to (or None).

Returns:

a new taglist that includes the old taglist with the new tenant_id tag set.

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.update_l2_gw_service(cluster, gateway_id, display_name)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.update_lrouter(cluster, lrouter_id, display_name, nexthop)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.update_lrouter_port_ips(cluster, lrouter_id, lport_id, ips_to_add, ips_to_remove)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.update_lswitch(cluster, lswitch_id, display_name, tenant_id=None, **kwargs)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.update_port(cluster, lswitch_uuid, lport_uuid, quantum_port_id, tenant_id, display_name, device_id, admin_status_enabled, mac_address=None, fixed_ips=None, port_security_enabled=None, security_profiles=None, queue_id=None)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.update_router_lport(cluster, lrouter_uuid, lrouter_port_uuid, tenant_id, quantum_port_id, display_name, admin_status_enabled, ip_addresses)

Updates a logical port on the assigned logical router

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.update_security_group_rules(cluster, spid, rules)

quantum.plugins.nicira.nicira_nvp_plugin.nvplib.version_dependent(wrapped_func)