Base classes for storage engines
ironic.db.api.
Connection
[source]¶Bases: object
Base class for storage system connections.
add_node_tag
(node_id, tag)[source]¶Add tag to the node.
If the node_id and tag pair already exists, this should still succeed.
node_id – The id of a node.
tag – A tag string.
the NodeTag object.
NodeNotFound if the node is not found.
add_node_trait
(node_id, trait, version)[source]¶Add trait to the node.
If the node_id and trait pair already exists, this should still succeed.
node_id – The id of a node.
trait – A trait string.
version – the version of the object.Trait.
the NodeTrait object.
InvalidParameterValue if adding the trait would exceed the per-node traits limit.
NodeNotFound if the node is not found.
check_node_list
(idents)[source]¶Check a list of node identities and map it to UUIDs.
This call takes a list of node names and/or UUIDs and tries to convert them to UUIDs. It fails early if any identities cannot possible be used as names or UUIDs.
idents – List of identities.
A mapping from requests identities to node UUIDs.
NodeNotFound if some identities were not found or cannot be valid names or UUIDs.
check_versions
(ignore_models=())[source]¶Checks the whole database for incompatible objects.
This scans all the tables in search of objects that are not supported; i.e., those that are not specified in ironic.common.release_mappings.RELEASE_MAPPING.
ignore_models – List of model names to skip.
A Boolean. True if all the objects have supported versions; False otherwise.
create_allocation
(values)[source]¶Create a new allocation.
values – Dict of values to create an allocation with
An allocation
AllocationDuplicateName
AllocationAlreadyExists
create_bios_setting_list
(node_id, settings, version)[source]¶Create a list of BIOSSetting records for a given node.
node_id – The node id.
settings –
A list of BIOS Settings to be created.
[
{
'name': String,
'value': String,
},
{
'name': String,
'value': String,
},
...
]
version – the version of the object.BIOSSetting.
A list of BIOSSetting object.
NodeNotFound if the node is not found.
BIOSSettingAlreadyExists if any of the setting records already exists.
create_deploy_template
(values)[source]¶Create a deployment template.
values –
A dict describing the deployment template. For example:
{
'uuid': uuidutils.generate_uuid(),
'name': 'CUSTOM_DT1',
}
DeployTemplateDuplicateName if a deploy template with the same name exists.
DeployTemplateAlreadyExists if a deploy template with the same UUID exists.
A deploy template.
create_node
(values)[source]¶Create a new node.
values –
A dict containing several items used to identify and track the node, and several dicts which are passed into the Drivers when managing this node. For example:
{
'uuid': uuidutils.generate_uuid(),
'instance_uuid': None,
'power_state': states.POWER_OFF,
'provision_state': states.AVAILABLE,
'driver': 'ipmi',
'driver_info': { ... },
'properties': { ... },
'extra': { ... },
}
InvalidParameterValue if ‘values’ contains ‘tags’ or ‘traits’.
A node.
create_portgroup
(values)[source]¶Create a new portgroup.
values – Dict of values with the following keys: ‘id’ ‘uuid’ ‘name’ ‘node_id’ ‘address’ ‘extra’ ‘created_at’ ‘updated_at’
A portgroup
PortgroupDuplicateName
PortgroupMACAlreadyExists
PortgroupAlreadyExists
create_volume_connector
(connector_info)[source]¶Create a new volume connector.
connector_info –
Dictionary containing information about the connector. Example:
{
'uuid': '000000-..',
'type': 'wwnn',
'connector_id': '00:01:02:03:04:05:06',
'node_id': 2
}
A volume connector.
VolumeConnectorTypeAndIdAlreadyExists If a connector already exists with a matching type and connector_id.
VolumeConnectorAlreadyExists If a volume connector with the same UUID already exists.
create_volume_target
(target_info)[source]¶Create a new volume target.
target_info –
Dictionary containing the information about the volume target. Example:
{
'uuid': '000000-..',
'node_id': 2,
'boot_index': 0,
'volume_id': '12345678-...'
'volume_type': 'some type',
}
A volume target.
VolumeTargetBootIndexAlreadyExists if a volume target already exists with the same boot index and node ID.
VolumeTargetAlreadyExists if a volume target with the same UUID exists.
delete_bios_setting_list
(node_id, names)[source]¶Delete a list of BIOS settings.
node_id – The node id.
names – List of BIOS setting names to be deleted.
NodeNotFound if the node is not found.
BIOSSettingNotFound if any of BIOS setting name is not found.
delete_node_tag
(node_id, tag)[source]¶Delete specified tag from the node.
node_id – The id of a node.
tag – A tag string.
NodeNotFound if the node is not found.
NodeTagNotFound if the tag is not found.
delete_node_trait
(node_id, trait)[source]¶Delete specified trait from the node.
node_id – The id of a node.
trait – A trait string.
NodeNotFound if the node is not found.
NodeTraitNotFound if the trait is not found.
destroy_allocation
(allocation_id)[source]¶Destroy an allocation.
allocation_id – Allocation ID
AllocationNotFound
destroy_chassis
(chassis_id)[source]¶Destroy a chassis.
chassis_id – The id or the uuid of a chassis.
destroy_deploy_template
(template_id)[source]¶Destroy a deployment template.
template_id – ID of the deployment template to destroy.
DeployTemplateNotFound if the deploy template does not exist.
destroy_node
(node_id)[source]¶Destroy a node and its associated resources.
Destroy a node, including any associated ports, port groups, tags, traits, volume connectors, and volume targets.
node_id – The ID or UUID of a node.
destroy_port
(port_id)[source]¶Destroy an port.
port_id – The id or MAC of a port.
destroy_portgroup
(portgroup_id)[source]¶Destroy a portgroup.
portgroup_id – The UUID or MAC of a portgroup.
PortgroupNotEmpty
PortgroupNotFound
destroy_volume_connector
(ident)[source]¶Destroy a volume connector.
ident – The UUID or integer ID of a volume connector.
VolumeConnectorNotFound If a volume connector with the specified ident does not exist.
destroy_volume_target
(ident)[source]¶Destroy a volume target.
ident – The UUID or integer ID of a volume target.
VolumeTargetNotFound if a volume target with the specified ident does not exist.
get_active_hardware_type_dict
(use_groups=False)[source]¶Retrieve hardware types for the registered and active conductors.
use_groups – Whether to factor conductor_group into the keys.
A dict which maps hardware type names to the set of hosts which support them. For example:
{hardware-type-a: set([host1, host2]),
hardware-type-b: set([host2, host3])}
get_allocation_by_id
(allocation_id)[source]¶Return an allocation representation.
allocation_id – The id of an allocation.
An allocation.
AllocationNotFound
get_allocation_by_name
(name)[source]¶Return an allocation representation.
name – The logical name of an allocation.
An allocation.
AllocationNotFound
get_allocation_by_uuid
(allocation_uuid)[source]¶Return an allocation representation.
allocation_uuid – The uuid of an allocation.
An allocation.
AllocationNotFound
get_allocation_list
(filters=None, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of allocations.
filters –
Filters to apply. Defaults to None.
uuid of node
allocation state
requested resource class
limit – Maximum number of allocations to return.
marker – The last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – Direction in which results should be sorted. (asc, desc)
A list of allocations.
get_bios_setting
(node_id, name)[source]¶Retrieve BIOS setting value.
node_id – The node id.
name – String containing name of BIOS setting to be retrieved.
The BIOSSetting object.
NodeNotFound if the node is not found.
BIOSSettingNotFound if the BIOS setting is not found.
get_bios_setting_list
(node_id)[source]¶Retrieve BIOS settings of a given node.
node_id – The node id.
A list of BIOSSetting objects.
NodeNotFound if the node is not found.
get_chassis_by_id
(chassis_id)[source]¶Return a chassis representation.
chassis_id – The id of a chassis.
A chassis.
get_chassis_by_uuid
(chassis_uuid)[source]¶Return a chassis representation.
chassis_uuid – The uuid of a chassis.
A chassis.
get_chassis_list
(limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of chassis.
limit – Maximum number of chassis to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – direction in which results should be sorted. (asc, desc)
get_conductor
(hostname, online=True)[source]¶Retrieve a conductor’s service record from the database.
hostname – The hostname of the conductor service.
online – Specify the filter value on the online field when
querying conductors. The online
field is ignored if
this value is set to None.
A conductor.
ConductorNotFound if the conductor with given hostname does not exist or doesn’t meet the specified online expectation.
get_conductor_list
(limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of conductors.
limit – Maximum number of conductors to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – direction in which results should be sorted. (asc, desc)
get_deploy_template_by_id
(template_id)[source]¶Retrieve a deployment template by ID.
template_id – ID of the deployment template to retrieve.
DeployTemplateNotFound if the deploy template does not exist.
A deploy template.
get_deploy_template_by_name
(template_name)[source]¶Retrieve a deployment template by name.
template_name – name of the deployment template to retrieve.
DeployTemplateNotFound if the deploy template does not exist.
A deploy template.
get_deploy_template_by_uuid
(template_uuid)[source]¶Retrieve a deployment template by UUID.
template_uuid – UUID of the deployment template to retrieve.
DeployTemplateNotFound if the deploy template does not exist.
A deploy template.
get_deploy_template_list
(limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Retrieve a list of deployment templates.
limit – Maximum number of deploy templates to return.
marker – The last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – Direction in which results should be sorted. (asc, desc)
A list of deploy templates.
get_deploy_template_list_by_names
(names)[source]¶Return a list of deployment templates with one of a list of names.
names – List of names to filter by.
A list of deploy templates.
get_node_by_id
(node_id)[source]¶Return a node.
node_id – The id of a node.
A node.
get_node_by_instance
(instance)[source]¶Return a node.
instance – The instance uuid to search for.
A node.
InstanceNotFound if the instance is not found.
InvalidUUID if the instance uuid is invalid.
get_node_by_name
(node_name)[source]¶Return a node.
node_name – The logical name of a node.
A node.
get_node_by_port_addresses
(addresses)[source]¶Find a node by any matching port address.
addresses – list of port addresses (e.g. MACs).
Node object.
NodeNotFound if none or several nodes are found.
get_node_by_uuid
(node_uuid)[source]¶Return a node.
node_uuid – The uuid of a node.
A node.
get_node_list
(filters=None, limit=None, marker=None, sort_key=None, sort_dir=None, fields=None)[source]¶Return a list of nodes.
filters –
Filters to apply. Defaults to None.
True | False
True | False
True | False
uuid of chassis
driver’s name
provision state of node
nodes with provision_updated_at field before this interval in seconds
limit – Maximum number of nodes to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – direction in which results should be sorted. (asc, desc)
fields – Comma separated field list to return, to allow for only specific fields to be returned to have maximum API performance calls where not all columns are needed from the database.
Get node tags based on its id.
node_id – The id of a node.
A list of NodeTag objects.
NodeNotFound if the node is not found.
get_node_traits_by_node_id
(node_id)[source]¶Get node traits based on its id.
node_id – The id of a node.
A list of NodeTrait objects.
NodeNotFound if the node is not found.
get_nodeinfo_list
(columns=None, filters=None, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Get specific columns for matching nodes.
Return a list of the specified columns for all nodes that match the specified filters.
columns – List of column names to return. Defaults to ‘id’ column when columns == None.
filters –
Filters to apply. Defaults to None.
True | False
True | False
[conductor1, conductor2]
True | False
True | False
uuid of chassis
driver’s name
provision state of node
nodes with provision_updated_at field before this interval in seconds
limit – Maximum number of nodes to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – direction in which results should be sorted. (asc, desc)
A list of tuples of the specified columns.
get_not_versions
(model_name, versions)[source]¶Returns objects with versions that are not the specified versions.
model_name – the name of the model (class) of desired objects
versions – list of versions of objects not to be returned
list of the DB objects
IronicException if there is no class associated with the name
get_offline_conductors
(field='hostname')[source]¶Get a list conductors that are offline (dead).
field – A field to return, hostname by default.
A list of requested fields of offline conductors.
get_online_conductors
()[source]¶Get a list conductor hostnames that are online and active.
A list of conductor hostnames.
get_port_by_address
(address)[source]¶Return a network port representation.
address – The MAC address of a port.
A port.
get_port_by_id
(port_id)[source]¶Return a network port representation.
port_id – The id of a port.
A port.
get_port_by_name
(port_name)[source]¶Return a network port representation.
port_name – The name of a port.
A port.
get_port_by_uuid
(port_uuid)[source]¶Return a network port representation.
port_uuid – The uuid of a port.
A port.
get_port_list
(limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶Return a list of ports.
limit – Maximum number of ports to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – direction in which results should be sorted. (asc, desc)
get_portgroup_by_address
(address, project=None)[source]¶Return a network portgroup representation.
address – The MAC address of a portgroup.
project – A node owner or lessee to filter by.
A portgroup.
PortgroupNotFound
get_portgroup_by_id
(portgroup_id)[source]¶Return a network portgroup representation.
portgroup_id – The id of a portgroup.
A portgroup.
PortgroupNotFound
get_portgroup_by_name
(name)[source]¶Return a network portgroup representation.
name – The logical name of a portgroup.
A portgroup.
PortgroupNotFound
get_portgroup_by_uuid
(portgroup_uuid)[source]¶Return a network portgroup representation.
portgroup_uuid – The uuid of a portgroup.
A portgroup.
PortgroupNotFound
get_portgroup_list
(limit=None, marker=None, sort_key=None, sort_dir=None, project=None)[source]¶Return a list of portgroups.
limit – Maximum number of portgroups to return.
marker – The last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – Direction in which results should be sorted. (asc, desc)
project – A node owner or lessee to filter by.
A list of portgroups.
get_portgroups_by_node_id
(node_id, limit=None, marker=None, sort_key=None, sort_dir=None, project=None)[source]¶List all the portgroups for a given node.
node_id – The integer node ID.
limit – Maximum number of portgroups to return.
marker – The last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted
sort_dir – Direction in which results should be sorted (asc, desc)
project – A node owner or lessee to filter by.
A list of portgroups.
get_ports_by_node_id
(node_id, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶List all the ports for a given node.
node_id – The integer node ID.
limit – Maximum number of ports to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted
sort_dir – direction in which results should be sorted (asc, desc)
A list of ports.
get_ports_by_portgroup_id
(portgroup_id, limit=None, marker=None, sort_key=None, sort_dir=None)[source]¶List all the ports for a given portgroup.
portgroup_id – The integer portgroup ID.
limit – Maximum number of ports to return.
marker – The last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted
sort_dir – Direction in which results should be sorted (asc, desc)
A list of ports.
get_volume_connector_by_id
(db_id)[source]¶Return a volume connector representation.
db_id – The integer database ID of a volume connector.
A volume connector with the specified ID.
VolumeConnectorNotFound If a volume connector with the specified ID is not found.
get_volume_connector_by_uuid
(connector_uuid)[source]¶Return a volume connector representation.
connector_uuid – The UUID of a connector.
A volume connector with the specified UUID.
VolumeConnectorNotFound If a volume connector with the specified UUID is not found.
get_volume_connector_list
(limit=None, marker=None, sort_key=None, sort_dir=None, project=None)[source]¶Return a list of volume connectors.
limit – Maximum number of volume connectors to return.
marker – The last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – Direction in which results should be sorted. (asc, desc)
project – The associated node project to search with.
a list of VolumeConnector
objects
A list of volume connectors.
InvalidParameterValue If sort_key does not exist.
get_volume_connectors_by_node_id
(node_id, limit=None, marker=None, sort_key=None, sort_dir=None, project=None)[source]¶List all the volume connectors for a given node.
node_id – The integer node ID.
limit – Maximum number of volume connectors to return.
marker – The last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted
sort_dir – Direction in which results should be sorted (asc, desc)
project – The associated node project to search with.
a list of VolumeConnector
objects
A list of volume connectors.
InvalidParameterValue If sort_key does not exist.
get_volume_target_by_id
(db_id)[source]¶Return a volume target representation.
db_id – The database primary key (integer) ID of a volume target.
A volume target.
VolumeTargetNotFound if no volume target with this ID exists.
get_volume_target_by_uuid
(uuid)[source]¶Return a volume target representation.
uuid – The UUID of a volume target.
A volume target.
VolumeTargetNotFound if no volume target with this UUID exists.
get_volume_target_list
(limit=None, marker=None, sort_key=None, sort_dir=None, project=None)[source]¶Return a list of volume targets.
limit – Maximum number of volume targets to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted.
sort_dir – direction in which results should be sorted. (asc, desc)
project – The associated node project to search with.
a list of VolumeConnector
objects
A list of volume targets.
InvalidParameterValue if sort_key does not exist.
get_volume_targets_by_node_id
(node_id, limit=None, marker=None, sort_key=None, sort_dir=None, project=None)[source]¶List all the volume targets for a given node.
node_id – The integer node ID.
limit – Maximum number of volume targets to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted
sort_dir – direction in which results should be sorted (asc, desc)
project – The associated node project to search with.
a list of VolumeConnector
objects
A list of volume targets.
InvalidParameterValue if sort_key does not exist.
get_volume_targets_by_volume_id
(volume_id, limit=None, marker=None, sort_key=None, sort_dir=None, project=None)[source]¶List all the volume targets for a given volume id.
volume_id – The UUID of the volume.
limit – Maximum number of volume targets to return.
marker – the last item of the previous page; we return the next result set.
sort_key – Attribute by which results should be sorted
sort_dir – direction in which results should be sorted (asc, desc)
A list of volume targets.
InvalidParameterValue if sort_key does not exist.
list_conductor_hardware_interfaces
(conductor_id)[source]¶List all registered hardware interfaces for a conductor.
conductor_id – Database ID of conductor.
List of ConductorHardwareInterfaces
objects.
list_hardware_type_interfaces
(hardware_types)[source]¶List registered hardware interfaces for given hardware types.
This is restricted to only active conductors.
:param hardware_types: list of hardware types to filter by.
:returns: list of ConductorHardwareInterfaces
objects.
migrate_from_iscsi_deploy
(context, max_count)[source]¶Tries to migrate away from the iscsi deploy interface.
context – the admin context
max_count – The maximum number of objects to migrate. Must be >= 0. If zero, all the objects will be migrated.
A 2-tuple, 1. the total number of objects that need to be migrated (at the beginning of this call) and 2. the number of migrated objects.
node_tag_exists
(node_id, tag)[source]¶Check if the specified tag exist on the node.
node_id – The id of a node.
tag – A tag string.
True if the tag exists otherwise False.
NodeNotFound if the node is not found.
node_trait_exists
(node_id, trait)[source]¶Check if the specified trait exists on the node.
node_id – The id of a node.
trait – A trait string.
True if the trait exists otherwise False.
NodeNotFound if the node is not found.
register_conductor
(values, update_existing=False)[source]¶Register an active conductor with the cluster.
values –
A dict of values which must contain the following:
{
'hostname': the unique hostname which identifies
this Conductor service.
'drivers': a list of supported drivers.
'version': the version of the object.Conductor
}
update_existing – When false, registration will raise an exception when a conflicting online record is found. When true, will overwrite the existing record. Default: False.
A conductor.
ConductorAlreadyRegistered
register_conductor_hardware_interfaces
(conductor_id, hardware_type, interface_type, interfaces, default_interface)[source]¶Registers hardware interfaces for a conductor.
conductor_id – Database ID of conductor to register for.
hardware_type – Name of hardware type for the interfaces.
interface_type – Type of interfaces, e.g. ‘deploy’ or ‘boot’.
interfaces – List of interface names to register.
default_interface – String, the default interface for this hardware type and interface type.
ConductorHardwareInterfacesAlreadyRegistered if at least one of the interfaces in the combination of all parameters is already registered.
release_node
(tag, node_id)[source]¶Release the reservation on a node.
tag – A string uniquely identifying the reservation holder.
node_id – A node id or uuid.
NodeNotFound if the node is not found.
NodeLocked if the node is reserved by another host.
NodeNotLocked if the node was found to not have a reservation at all.
reserve_node
(tag, node_id)[source]¶Reserve a node.
To prevent other ManagerServices from manipulating the given Node while a Task is performed, mark it reserved by this host.
tag – A string uniquely identifying the reservation holder.
node_id – A node id or uuid.
A Node object.
NodeNotFound if the node is not found.
NodeLocked if the node is already reserved.
Replace all of the node tags with specified list of tags.
This ignores duplicate tags in the specified list.
node_id – The id of a node.
tags – List of tags.
A list of NodeTag objects.
NodeNotFound if the node is not found.
set_node_traits
(node_id, traits, version)[source]¶Replace all of the node traits with specified list of traits.
This ignores duplicate traits in the specified list.
node_id – The id of a node.
traits – List of traits.
version – the version of the object.Trait.
A list of NodeTrait objects.
InvalidParameterValue if setting the traits would exceed the per-node traits limit.
NodeNotFound if the node is not found.
take_over_allocation
(allocation_id, old_conductor_id, new_conductor_id)[source]¶Do a take over for an allocation.
The allocation is only updated if the old conductor matches the provided value, thus guarding against races.
allocation_id – Allocation ID
old_conductor_id – The conductor ID we expect to be the current
conductor_affinity
of the allocation.
new_conductor_id – The conductor ID of the new
conductor_affinity
.
True if the take over was successful, False otherwise.
AllocationNotFound
touch_conductor
(hostname)[source]¶Mark a conductor as active by updating its ‘updated_at’ property.
hostname – The hostname of this conductor service.
ConductorNotFound
touch_node_provisioning
(node_id)[source]¶Mark the node’s provisioning as running.
Mark the node’s provisioning as running by updating its ‘provision_updated_at’ property.
node_id – The id of a node.
NodeNotFound
unregister_conductor
(hostname)[source]¶Remove this conductor from the service registry immediately.
hostname – The hostname of this conductor service.
ConductorNotFound
unregister_conductor_hardware_interfaces
(conductor_id)[source]¶Unregisters all hardware interfaces for a conductor.
conductor_id – Database ID of conductor to unregister for.
Remove all tags of the node.
node_id – The id of a node.
NodeNotFound if the node is not found.
unset_node_traits
(node_id)[source]¶Remove all traits of the node.
node_id – The id of a node.
NodeNotFound if the node is not found.
update_allocation
(allocation_id, values, update_node=True)[source]¶Update properties of an allocation.
allocation_id – Allocation ID
values – Dict of values to update.
update_node – If True and node_id is updated, update the node with instance_uuid and traits from the allocation
An allocation.
AllocationNotFound
AllocationDuplicateName
InstanceAssociated
NodeAssociated
update_bios_setting_list
(node_id, settings, version)[source]¶Update a list of BIOSSetting records.
node_id – The node id.
settings –
A list of BIOS Settings to be updated.
[
{
'name': String,
'value': String,
},
{
'name': String,
'value': String,
},
...
]
version – the version of the object.BIOSSetting.
A list of BIOSSetting objects.
NodeNotFound if the node is not found.
BIOSSettingNotFound if any of the settings is not found.
update_chassis
(chassis_id, values)[source]¶Update properties of an chassis.
chassis_id – The id or the uuid of a chassis.
values – Dict of values to update.
A chassis.
update_deploy_template
(template_id, values)[source]¶Update a deployment template.
template_id – ID of the deployment template to update.
values –
A dict describing the deployment template. For example:
{
'uuid': uuidutils.generate_uuid(),
'name': 'CUSTOM_DT1',
}
DeployTemplateDuplicateName if a deploy template with the same name exists.
DeployTemplateNotFound if the deploy template does not exist.
A deploy template.
update_node
(node_id, values)[source]¶Update properties of a node.
node_id – The id or uuid of a node.
values –
Dict of values to update. May be a partial list, eg. when setting the properties for a driver. For example:
{
'driver_info':
{
'my-field-1': val1,
'my-field-2': val2,
}
}
A node.
NodeAssociated
NodeNotFound
update_port
(port_id, values)[source]¶Update properties of an port.
port_id – The id or MAC of a port.
values – Dict of values to update.
A port.
update_portgroup
(portgroup_id, values)[source]¶Update properties of a portgroup.
portgroup_id – The UUID or MAC of a portgroup.
values – Dict of values to update. May contain the following keys: ‘uuid’ ‘name’ ‘node_id’ ‘address’ ‘extra’ ‘created_at’ ‘updated_at’
A portgroup.
InvalidParameterValue
PortgroupNotFound
PortgroupDuplicateName
PortgroupMACAlreadyExists
update_to_latest_versions
(context, max_count)[source]¶Updates objects to their latest known versions.
This scans all the tables and for objects that are not in their latest version, updates them to that version.
context – the admin context
max_count – The maximum number of objects to migrate. Must be >= 0. If zero, all the objects will be migrated.
A 2-tuple, 1. the total number of objects that need to be migrated (at the beginning of this call) and 2. the number of migrated objects.
update_volume_connector
(ident, connector_info)[source]¶Update properties of a volume connector.
ident – The UUID or integer ID of a volume connector.
connector_info – Dictionary containing the information about connector to update.
A volume connector.
VolumeConnectorTypeAndIdAlreadyExists If another connector already exists with a matching type and connector_id field.
VolumeConnectorNotFound If a volume connector with the specified ident does not exist.
InvalidParameterValue When a UUID is included in connector_info.
update_volume_target
(ident, target_info)[source]¶Update information for a volume target.
ident – The UUID or integer ID of a volume target.
target_info – Dictionary containing the information about volume target to update.
A volume target.
InvalidParameterValue if a UUID is included in target_info.
VolumeTargetBootIndexAlreadyExists if a volume target already exists with the same boot index and node ID.
VolumeTargetNotFound if no volume target with this ident exists.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.