The quantum.quantum_plugin_base_v2 Module

v2 Quantum Plug-in API specification.

QuantumPluginBase provides the definition of minimum set of methods that needs to be implemented by a v2 Quantum Plug-in.

class quantum.quantum_plugin_base_v2.QuantumPluginBaseV2

Bases: object

create_network(context, network)

Create a network, which represents an L2 network segment which can have a set of subnets and ports associated with it. : param context: quantum api request context : param network: dictionary describing the network, with keys

as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. All keys will be populated.

create_port(context, port)

Create a port, which is a connection point of a device (e.g., a VM NIC) to attach to a L2 Quantum network. : param context: quantum api request context : param port: dictionary describing the port, with keys

as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. All keys will be populated.

create_subnet(context, subnet)

Create a subnet, which represents a range of IP addresses that can be allocated to devices : param context: quantum api request context : param subnet: dictionary describing the subnet, with keys

as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. All keys will be populated.

delete_network(context, id)

Delete a network. : param context: quantum api request context : param id: UUID representing the network to delete.

delete_port(context, id)

Delete a port. : param context: quantum api request context : param id: UUID representing the port to delete.

delete_subnet(context, id)

Delete a subnet. : param context: quantum api request context : param id: UUID representing the subnet to delete.

get_network(context, id, fields=None)

Retrieve a network. : param context: quantum api request context : param id: UUID representing the network to fetch. : param fields: a list of strings that are valid keys in a

network dictionary as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Only these fields will be returned.

get_networks(context, filters=None, fields=None, sorts=None, limit=None, marker=None, page_reverse=False)

Retrieve a list of networks. The contents of the list depends on the identity of the user making the request (as indicated by the context) as well as any filters. : param context: quantum api request context : param filters: a dictionary with keys that are valid keys for

a network as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Values in this dictiontary are an iterable containing values that will be used for an exact match comparison for that value. Each result returned by this function will have matched one of the values for each key in filters.

: param fields: a list of strings that are valid keys in a

network dictionary as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Only these fields will be returned.

get_networks_count(context, filters=None)

Return the number of networks. The result depends on the identity of the user making the request (as indicated by the context) as well as any filters. : param context: quantum api request context : param filters: a dictionary with keys that are valid keys for

a network as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Values in this dictiontary are an iterable containing values that will be used for an exact match comparison for that value. Each result returned by this function will have matched one of the values for each key in filters.

NOTE: this method is optional, as it was not part of the originally

defined plugin API.

get_port(context, id, fields=None)

Retrieve a port. : param context: quantum api request context : param id: UUID representing the port to fetch. : param fields: a list of strings that are valid keys in a

port dictionary as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Only these fields will be returned.

get_ports(context, filters=None, fields=None, sorts=None, limit=None, marker=None, page_reverse=False)

Retrieve a list of ports. The contents of the list depends on the identity of the user making the request (as indicated by the context) as well as any filters. : param context: quantum api request context : param filters: a dictionary with keys that are valid keys for

a port as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Values in this dictiontary are an iterable containing values that will be used for an exact match comparison for that value. Each result returned by this function will have matched one of the values for each key in filters.

: param fields: a list of strings that are valid keys in a

port dictionary as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Only these fields will be returned.

get_ports_count(context, filters=None)

Return the number of ports. The result depends on the identity of the user making the request (as indicated by the context) as well as any filters. : param context: quantum api request context : param filters: a dictionary with keys that are valid keys for

a network as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Values in this dictiontary are an iterable containing values that will be used for an exact match comparison for that value. Each result returned by this function will have matched one of the values for each key in filters.

NOTE: this method is optional, as it was not part of the originally

defined plugin API.

get_subnet(context, id, fields=None)

Retrieve a subnet. : param context: quantum api request context : param id: UUID representing the subnet to fetch. : param fields: a list of strings that are valid keys in a

subnet dictionary as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Only these fields will be returned.

get_subnets(context, filters=None, fields=None, sorts=None, limit=None, marker=None, page_reverse=False)

Retrieve a list of subnets. The contents of the list depends on the identity of the user making the request (as indicated by the context) as well as any filters. : param context: quantum api request context : param filters: a dictionary with keys that are valid keys for

a subnet as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Values in this dictiontary are an iterable containing values that will be used for an exact match comparison for that value. Each result returned by this function will have matched one of the values for each key in filters.

: param fields: a list of strings that are valid keys in a

subnet dictionary as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Only these fields will be returned.

get_subnets_count(context, filters=None)

Return the number of subnets. The result depends on the identity of the user making the request (as indicated by the context) as well as any filters. : param context: quantum api request context : param filters: a dictionary with keys that are valid keys for

a network as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py. Values in this dictiontary are an iterable containing values that will be used for an exact match comparison for that value. Each result returned by this function will have matched one of the values for each key in filters.

NOTE: this method is optional, as it was not part of the originally

defined plugin API.

update_network(context, id, network)

Update values of a network. : param context: quantum api request context : param id: UUID representing the network to update. : param network: dictionary with keys indicating fields to update.

valid keys are those that have a value of True for ‘allow_put’ as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py.

update_port(context, id, port)

Update values of a port. : param context: quantum api request context : param id: UUID representing the port to update. : param port: dictionary with keys indicating fields to update.

valid keys are those that have a value of True for ‘allow_put’ as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py.

update_subnet(context, id, subnet)

Update values of a subnet. : param context: quantum api request context : param id: UUID representing the subnet to update. : param subnet: dictionary with keys indicating fields to update.

valid keys are those that have a value of True for ‘allow_put’ as listed in the RESOURCE_ATTRIBUTE_MAP object in quantum/api/v2/attributes.py.