Terry Howe a065dd09e4 Allow network find to use alternate name
Add the name_attr to the network find method so it can search
for things like floating_ip_address for floating IP addresses
rather than just id.

Change-Id: I827e3745b06397a54555d1286e477bf2e05bf789
2014-07-07 06:11:58 -06:00

46 lines
1.7 KiB
Python

# 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 openstackclient.common import exceptions
def find(client, resource, resources, name_or_id, name_attr='name'):
"""Find a network resource
:param client: network client
:param resource: name of the resource
:param resources: plural name of resource
:param name_or_id: name or id of resource user is looking for
:param name_attr: key to the name attribute for the resource
For example:
n = find(netclient, 'network', 'networks', 'matrix')
"""
list_method = getattr(client, "list_%s" % resources)
# Search for by name
kwargs = {name_attr: name_or_id, 'fields': 'id'}
data = list_method(**kwargs)
info = data[resources]
if len(info) == 1:
return info[0]['id']
if len(info) > 1:
msg = "More than one %s exists with the name '%s'."
raise exceptions.CommandError(msg % (resource, name_or_id))
# Search for by id
data = list_method(id=name_or_id, fields='id')
info = data[resources]
if len(info) == 1:
return info[0]['id']
msg = "No %s with a name or ID of '%s' exists." % (resource, name_or_id)
raise exceptions.CommandError(msg)