This is the trivial-openstack Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 18:08:29 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
trivial-openstackA simple Common Lisp OpenStack REST client.
Smith Dhumbumroong <zodmaner@gmail.com>
MIT
drakma (system).
st-json (system).
local-time (system).
alexandria (system).
package.lisp (file).
trivial-openstack.lisp (file).
identity-api.lisp (file).
image-api.lisp (file).
compute-api.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
trivial-openstack/trivial-openstack.asdtrivial-openstack/package.lisptrivial-openstack/trivial-openstack.lisptrivial-openstack/identity-api.lisptrivial-openstack/image-api.lisptrivial-openstack/compute-api.lisptrivial-openstack/trivial-openstack.asdtrivial-openstack (system).
trivial-openstack/trivial-openstack.lisppackage.lisp (file).
trivial-openstack (system).
def-openstack-api (macro).
get-value (function).
join-strings (function).
with-openstack-response (macro).
trivial-openstack/identity-api.lisptrivial-openstack.lisp (file).
trivial-openstack (system).
*openstack-keystone* (special variable).
authenticate (function).
get-public-url (function).
initialize-instance (method).
service-catalog (reader method).
(setf service-catalog) (writer method).
token (reader method).
token (method).
(setf token) (writer method).
token-expiration-time (reader method).
(setf token-expiration-time) (writer method).
credential (reader method).
keystone-hostname (reader method).
make-openstack-credential (function).
make-openstack-keystone (function).
openstack-credential (class).
openstack-keystone (class).
parse-endpoints (function).
password (reader method).
tenant-name (reader method).
(setf tenant-name) (writer method).
username (reader method).
with-keystone-response (macro).
trivial-openstack/image-api.lispidentity-api.lisp (file).
trivial-openstack (system).
list-images (function).
trivial-openstack/compute-api.lispimage-api.lisp (file).
trivial-openstack (system).
add-security-rule-accept-all-icmp (function).
add-security-rule-accept-all-tcp (function).
add-security-rule-accept-all-udp (function).
associate-floating-ip (function).
create-default-security-group-rule (function).
create-floating-ip (function).
create-server (function).
delete-server (function).
list-default-security-group-rules (function).
list-flavor-details (function).
list-flavors (function).
list-floating-ips (function).
list-servers (function).
list-servers-details (function).
Packages are listed by definition order.
trivial-openstackalexandria.
common-lisp.
*openstack-keystone* (special variable).
add-security-rule-accept-all-icmp (function).
add-security-rule-accept-all-tcp (function).
add-security-rule-accept-all-udp (function).
associate-floating-ip (function).
authenticate (function).
create-default-security-group-rule (function).
create-floating-ip (function).
create-server (function).
def-openstack-api (macro).
delete-server (function).
get-public-url (function).
get-value (function).
list-default-security-group-rules (function).
list-flavor-details (function).
list-flavors (function).
list-floating-ips (function).
list-images (function).
list-servers (function).
list-servers-details (function).
service-catalog (generic reader).
(setf service-catalog) (generic writer).
token (generic function).
(setf token) (generic writer).
token-expiration-time (generic reader).
(setf token-expiration-time) (generic writer).
credential (generic reader).
join-strings (function).
keystone-hostname (generic reader).
make-openstack-credential (function).
make-openstack-keystone (function).
openstack-credential (class).
openstack-keystone (class).
parse-endpoints (function).
password (generic reader).
tenant-name (generic reader).
(setf tenant-name) (generic writer).
username (generic reader).
with-keystone-response (macro).
with-openstack-response (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
The default global OpenStack Keystone object.
Defines a new OpenStack REST API binding.
Adds a security rule that accepts all incoming ICMP connection to the default security group.
Adds a security rule that accepts all incoming TCP connection to the default security group.
Adds a security rule that accepts all incoming UDP connection to the default security group.
Associates a floating IP with an active server.
Authenticates a user, and initializes the default global Keystone special variables.
Creates a new security rule in the default security group.
Creates/allocates a new floating IP.
Creates a new server.
Deletes a server.
Retrieves a public URL of an OpenStack service endpoint either from the default alist map of currently active endpoints or a user-defined one.
Retrieves the value of a given key in an alist.
If multiple keys are supplied, then get-value will recursively descend
into the nested alist and retrieve the value of the last (or the
rightmost) key.
Note that supplying multiple keys only makes sense when the alist has other alists nested inside.
Lists all the currently active security rules in the default security group.
List a flavor details.
Lists all of the currently available flavors.
Lists all of the currently allocated floating IPs.
Retrieves the list of currently available images.
Lists all of the currently active servers.
Lists all of the currently active servers in details.
openstack-keystone)) ¶automatically generated reader method
openstack-keystone)) ¶automatically generated writer method
openstack-keystone)) ¶Before reading a value of the token’s slot, check if it has already expired. If it does, then uses the credential payload to re-authenticate and reacquire the token.
openstack-keystone)) ¶automatically generated reader method
openstack-keystone)) ¶automatically generated writer method
openstack-keystone)) ¶automatically generated reader method
openstack-keystone)) ¶automatically generated writer method
openstack-keystone) &key) ¶Uses an instant of user credential payload to authenticate and
retrieve a token, along with its expiration time, then stores them
into their respective slots.
Also retrieves currently active service catalog endpoints, parses them into an alist map, and stores them into their slot.
Authenticates a user by sending a credential payload to the Keystone identity service endpoint and binds a stream of the response that is returned to a specified stream symbol.
Sends an API request to an OpenStack endpoint at URI and binds a
stream of the response body that is returned by an OpenStack service
to a user specified response stream symbol.
If the returned stream has zero length, then NIL will be bound to the
stream symbol. If an error status code is returned, then the function
will throw an error.
The x-auth-token optional argument can be used to send the authentication token to the endpoint, while the content optional argument can be used to send additional content (usually a JSON) along with the request.
Joins strings.
Makes and returns a new instant of OpenStack credential class.
Creates and returns a new instant of the OpenStack Keystone object.
Parses a JSON containing currently active service endpoints into an alist map.
openstack-keystone)) ¶automatically generated reader method
openstack-credential)) ¶automatically generated reader method
openstack-credential)) ¶automatically generated reader method
openstack-credential)) ¶automatically generated reader method
openstack-credential)) ¶automatically generated writer method
openstack-credential)) ¶automatically generated reader method
An OpenStack credential payload, with all the
necessary information to authenticate a user.
Requires a hostname of the Keystone identity service, a username, and a password. The tenant-name is an optional argument that will default to username if not provided.
An OpenStack Keystone object containing an
authentication token, along with all the necessary information to
reacquire the token once it expires, and an alist map of service
catalog endpoints.
Only requires an instant of user credential payload to instantiate, other slots will be initialized when we instantiate the object.
| Jump to: | (
A C D F G I J K L M P S T U W |
|---|
| Jump to: | (
A C D F G I J K L M P S T U W |
|---|
| Jump to: | *
C K P S T U |
|---|
| Jump to: | *
C K P S T U |
|---|
| Jump to: | C F I O P S T |
|---|
| Jump to: | C F I O P S T |
|---|