This is the cl-openstack-client Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:14:42 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
cl-openstack-clientOpenStack client libraries
Julien Danjou <julien@danjou.info>
Apache-2.0
drakma (system).
cl-json (system).
local-time (system).
alexandria (system).
uri-template (system).
openstack.lisp (file).
keystone.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
cl-openstack-client/cl-openstack-client.asdcl-openstack-client/openstack.lispcl-openstack-client/keystone.lispcl-openstack-client/cl-openstack-client.asdcl-openstack-client (system).
cl-openstack-client/openstack.lispcl-openstack-client (system).
*http-stream* (special variable).
*resource-uri* (special variable).
assoc* (function).
decode-resource (method).
decode-resource-list (method).
def-rest-generic (macro).
def-rest-method (macro).
error-code (reader method).
(setf error-code) (writer method).
error-message (reader method).
(setf error-message) (writer method).
handle-http-error (function).
openstack-error (condition).
print-object (method).
request-resource (function).
resource (class).
resource-authentication-headers (generic function).
resource-connection (reader method).
resource-error-class (method).
resource-id (reader method).
service-url (generic function).
convert-header-resources (function).
convert-lambda-list-resources (function).
json-error (function).
json-response-p (function).
lambda-list-variables (function).
return-first-connection (function).
unknown-error (function).
cl-openstack-client/keystone.lispopenstack.lisp (file).
cl-openstack-client (system).
add-user (generic function).
authenticate (generic function).
connection-password (reader method).
connection-service-catalog (reader method).
connection-tenant (method).
connection-tenant-id (reader method).
connection-tenant-name (reader method).
connection-token-expires (generic function).
connection-token-id (generic function).
connection-token-issued-at (generic function).
connection-token-valid-p (generic function).
connection-url (reader method).
connection-username (reader method).
connection-v2 (class).
decode-resource (method).
delete-user (generic function).
encode-json (method).
encode-json (method).
get-user (method).
keystone-error (condition).
list-roles (generic function).
list-tenants (generic function).
list-users (generic function).
print-object (method).
resource-authentication-headers (method).
resource-authentication-headers (method).
resource-connection (method).
resource-error-class (method).
resource-error-class (method).
resource-name (reader method).
role-enabled (reader method).
role-id (reader method).
role-name (reader method).
service-url (method).
service-url (method).
tenant (class).
tenant-description (reader method).
tenant-enabled (reader method).
tenant-id (reader method).
tenant-name (reader method).
user-email (reader method).
user-enabled (reader method).
user-id (method).
user-id (method).
user-name (method).
user-name (reader method).
user-tenant (reader method).
add-tenant-users-role (generic function).
connection (class).
connection-endpoint (reader method).
connection-version (reader method).
decode-json (function).
delete-tenants-user-role (generic function).
filter-endpoints (function).
headers-for (method).
named-resource-v2 (class).
openstack-camel-case-to-lisp (function).
resource-v2 (class).
role (class).
role-v2 (class).
service-catalog-query (method).
tenant-v2 (class).
user (class).
user-v2 (class).
Packages are listed by definition order.
cl-openstack-clientcommon-lisp.
*http-stream* (special variable).
*resource-uri* (special variable).
assoc* (function).
decode-resource (generic function).
decode-resource-list (generic function).
def-rest-generic (macro).
def-rest-method (macro).
error-code (generic reader).
(setf error-code) (generic writer).
error-message (generic reader).
(setf error-message) (generic writer).
handle-http-error (function).
id (slot).
id (slot).
openstack-error (condition).
request-resource (function).
resource (class).
resource-authentication-headers (generic function).
resource-connection (generic function).
resource-error-class (generic function).
resource-id (generic reader).
service-url (generic function).
convert-header-resources (function).
convert-lambda-list-resources (function).
json-error (function).
json-response-p (function).
lambda-list-variables (function).
return-first-connection (function).
unknown-error (function).
cl-keystone-clientcommon-lisp.
add-user (generic function).
authenticate (generic function).
connection-password (generic reader).
connection-service-catalog (generic reader).
connection-tenant (generic function).
connection-tenant-id (generic reader).
connection-tenant-name (generic reader).
connection-token-expires (generic function).
connection-token-id (generic function).
connection-token-issued-at (generic function).
connection-token-valid-p (generic function).
connection-url (generic reader).
connection-username (generic reader).
connection-v2 (class).
delete-user (generic function).
get-user (generic function).
keystone-error (condition).
list-roles (generic function).
list-tenants (generic function).
list-users (generic function).
resource-name (generic reader).
role-enabled (generic reader).
role-id (generic reader).
role-name (generic reader).
tenant (class).
tenant-description (generic reader).
tenant-enabled (generic reader).
tenant-id (generic reader).
tenant-name (generic reader).
user-email (generic reader).
user-enabled (generic reader).
user-id (generic function).
user-name (generic function).
user-tenant (generic reader).
add-tenant-users-role (generic function).
connection (class).
connection-endpoint (generic reader).
connection-version (generic reader).
decode-json (function).
delete-tenants-user-role (generic function).
filter-endpoints (function).
headers-for (generic function).
named-resource-v2 (class).
openstack-camel-case-to-lisp (function).
resource-v2 (class).
role (class).
role-v2 (class).
service-catalog-query (generic function).
tenant-v2 (class).
user (class).
user-v2 (class).
Definitions are sorted by export status, category, package, and then by lexicographic order.
This stream is primarily used for dependency injection in testcases.
Define a generic with REST methods.
A convenience wrapper around request-resource.
NAME is the name of the method. LAMBDA-LIST is a method lambda list,
it’s first element will be used to source a connection, so it must be
of the type RESOURCE or CONNECTION.
OPTIONS is in the form of an ALIST and can contain URI or
DOCUMENTATION elements.
URI is the uri to the resource you are looking for it supports
RFC6570 tempting and will be evaluated in the context of the method as
if in a PROGN so values from the LAMBDA-LIST will be substituted in
provided the symbol names match. Any RESOURCE types will have their
RESOURCE-ID methods called before substitution. Only simple expansion
is supported from the RFC. The resulting URI will be bound to the
*RESOURCE-URI* variable for use within other helper functions.
DOCUMENTATION a documentation string that will be assigned to the
method.
BODY is a for the method body.
Return the CDR of the ASSOC result.
connection-v2) &key name email enabled password) ¶Add a user.
Authenticate and retrieve a token.
connection-v2)) ¶connection)) ¶automatically generated reader method
connection)) ¶automatically generated reader method
connection-v2)) ¶Return the current connections TENANT.
connection)) ¶automatically generated reader method
connection)) ¶automatically generated reader method
Return the time when the CONNECTION’s token will expire.
connection-v2)) ¶Retrieve token id for CONNECTION.
connection-v2)) ¶Return the time the CONNECTION’s token was issued at.
connection-v2)) ¶Return T if the CONNECTION’s token is still valid.
connection-v2)) ¶connection)) ¶automatically generated reader method
url.
connection)) ¶automatically generated reader method
(eql cl-keystone-client::tenant-v2)) (parent connection-v2) stream) ¶connection-v2) user-or-user-id) ¶Delete a user.
openstack-error)) ¶openstack-error)) ¶code.
openstack-error)) ¶openstack-error)) ¶Gets information for a specified user.
user-v2)) ¶Lists global roles for a specified user. Excludes tenant roles.
connection-v2)) ¶List roles.
connection-v2)) ¶List all the tenants.
connection-v2)) ¶List all users in keystone.
Return a list of the authentication headers that should be added to the request.
resource-v2)) ¶connection-v2)) ¶connection)) ¶resource-v2)) ¶connection)) ¶named-resource-v2)) ¶automatically generated reader method
name.
resource-v2) &optional service) ¶connection-v2) &optional service) ¶connection-v2)) ¶connection-v2)) ¶connection) &optional stream) ¶Write the JSON representation (Object) of the keystone CONNECTION to STREAM (or to *JSON-OUTPUT*).
json.
tenant-v2) &optional stream) ¶Write the JSON representation (Object) of the keystone CONNECTION to STREAM (or to *JSON-OUTPUT*).
json.
named-resource-v2) stream) ¶error.
The error message returned by Openstack.
(quote nil)
:message
The error code returned by Openstack.
(quote nil)
:code
add-user.
authenticate.
connection-tenant.
connection-token-expires.
connection-token-id.
connection-token-issued-at.
connection-token-valid-p.
connection-version.
decode-resource.
delete-user.
headers-for.
list-roles.
list-tenants.
list-users.
resource-authentication-headers.
service-catalog-query.
service-url.
user-id.
user-name.
2
This slot is read-only.
:id
This slot is read-only.
:name
This slot is read-only.
:enabled
This slot is read-only.
:description
This slot is read-only.
Take a list of headers and resolve any RESOURCE types to their RESOURCE-ID’s
Raise an error using the contents of a JSON error plist.
Return true if the response content type is json.
Convert camel case JSON keys to lisp symbol names. This function handles keys with names like publicURL better and will convert keys with underscores to hyphens.
Raise an error with the url and status code.
Adds a specified role to a user for a tenant.
connection)) ¶automatically generated reader method
connection-v2)) ¶automatically generated reader method
Deletes a specified role from a user on a tenant.
connection-v2) &optional action) ¶connection-v2) service-type &key type) ¶(error ":username is required when creating a connection.")
:username
This slot is read-only.
:tenant-id
This slot is read-only.
:tenant-name
This slot is read-only.
(error ":password is required when creating a connection.")
:password
This slot is read-only.
:public-url
:endpoint
This slot is read-only.
This slot is read-only.
(error ":url is required when creating a connection.")
:url
This slot is read-only.
:name
This slot is read-only.
:tenant-id
This slot is read-only.
:enabled
This slot is read-only.
:email
This slot is read-only.
| Jump to: | (
A C D E F G H J L M O P R S T U |
|---|
| Jump to: | (
A C D E F G H J L M O P R S T U |
|---|
| Jump to: | *
A C D E I M N P S T U V |
|---|
| Jump to: | *
A C D E I M N P S T U V |
|---|
| Jump to: | C F K N O P R S T U |
|---|
| Jump to: | C F K N O P R S T U |
|---|