1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
# Copyright 2011 OpenStack Foundation
# All Rights Reserved.
#
# 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.
"""
Keypair interface
"""
from novaclient import api_versions
from novaclient import base
class Keypair(base.Resource):
"""
A keypair is a ssh key that can be injected into a server on launch.
"""
def __repr__(self):
return "<Keypair: %s>" % self.id
def _add_details(self, info):
dico = 'keypair' in info and \
info['keypair'] or info
for (k, v) in dico.items():
# NOTE(rpodolyaka): keypair name allows us to uniquely identify
# a specific keypair, while its id attribute
# is nothing more than an implementation
# detail. We can safely omit the id attribute
# here to ensure setattr() won't raise
# AttributeError trying to set read-only
# property id
if k != 'id':
setattr(self, k, v)
@property
def id(self):
return self.name
def delete(self):
"""
Delete this keypair.
:returns: An instance of novaclient.base.TupleWithMeta
"""
return self.manager.delete(self)
class KeypairManager(base.ManagerWithFind):
resource_class = Keypair
keypair_prefix = "os-keypairs"
is_alphanum_id_allowed = True
@api_versions.wraps("2.0", "2.9")
def get(self, keypair):
"""
Get a keypair.
:param keypair: The ID of the keypair to get.
:rtype: :class:`Keypair`
"""
return self._get("/%s/%s" % (self.keypair_prefix, base.getid(keypair)),
"keypair")
@api_versions.wraps("2.10")
def get(self, keypair, user_id=None):
"""
Get a keypair.
:param keypair: The ID of the keypair to get.
:param user_id: Id of key-pair owner (Admin only).
:rtype: :class:`Keypair`
"""
query_string = "?user_id=%s" % user_id if user_id else ""
url = "/%s/%s%s" % (self.keypair_prefix, base.getid(keypair),
query_string)
return self._get(url, "keypair")
@api_versions.wraps("2.0", "2.1")
def create(self, name, public_key=None):
"""
Create a keypair
:param name: name for the keypair to create
:param public_key: existing public key to import
"""
body = {'keypair': {'name': name}}
if public_key:
body['keypair']['public_key'] = public_key
return self._create('/%s' % self.keypair_prefix, body, 'keypair')
@api_versions.wraps("2.2", "2.9")
def create(self, name, public_key=None, key_type="ssh"):
"""
Create a keypair
:param name: name for the keypair to create
:param public_key: existing public key to import
:param key_type: keypair type to create
"""
body = {'keypair': {'name': name,
'type': key_type}}
if public_key:
body['keypair']['public_key'] = public_key
return self._create('/%s' % self.keypair_prefix, body, 'keypair')
@api_versions.wraps("2.10")
def create(self, name, public_key=None, key_type="ssh", user_id=None):
"""
Create a keypair
:param name: name for the keypair to create
:param public_key: existing public key to import
:param key_type: keypair type to create
:param user_id: user to add.
"""
body = {'keypair': {'name': name,
'type': key_type}}
if public_key:
body['keypair']['public_key'] = public_key
if user_id:
body['keypair']['user_id'] = user_id
return self._create('/%s' % self.keypair_prefix, body, 'keypair')
@api_versions.wraps("2.0", "2.9")
def delete(self, key):
"""
Delete a keypair
:param key: The :class:`Keypair` (or its ID) to delete.
:returns: An instance of novaclient.base.TupleWithMeta
"""
return self._delete('/%s/%s' % (self.keypair_prefix, base.getid(key)))
@api_versions.wraps("2.10")
def delete(self, key, user_id=None):
"""
Delete a keypair
:param key: The :class:`Keypair` (or its ID) to delete.
:param user_id: Id of key-pair owner (Admin only).
:returns: An instance of novaclient.base.TupleWithMeta
"""
query_string = "?user_id=%s" % user_id if user_id else ""
url = '/%s/%s%s' % (self.keypair_prefix, base.getid(key), query_string)
return self._delete(url)
@api_versions.wraps("2.0", "2.9")
def list(self):
"""
Get a list of keypairs.
"""
return self._list('/%s' % self.keypair_prefix, 'keypairs')
@api_versions.wraps("2.10", "2.34")
def list(self, user_id=None):
"""
Get a list of keypairs.
:param user_id: Id of key-pairs owner (Admin only).
"""
params = {}
if user_id:
params['user_id'] = user_id
return self._list('/%s' % self.keypair_prefix, 'keypairs',
filters=params)
@api_versions.wraps("2.35")
def list(self, user_id=None, marker=None, limit=None):
"""
Get a list of keypairs.
:param user_id: Id of key-pairs owner (Admin only).
:param marker: Begin returning keypairs that appear later in the
keypair list than that represented by this keypair name
(optional).
:param limit: maximum number of keypairs to return (optional).
Note the API server has a configurable default limit.
If no limit is specified here or limit is larger than
default, the default limit will be used.
"""
params = {}
if user_id:
params['user_id'] = user_id
if limit:
params['limit'] = int(limit)
if marker:
params['marker'] = str(marker)
return self._list('/%s' % self.keypair_prefix, 'keypairs',
filters=params)
|
