'>
'>
'>
'>
'>
'>
'>
Returns a unique request ID that provides tracking for the
request. Provider must configure middleware to provide the request
ID.
'>
Filters the results by a specified server name in URL format.Filters the results by a specified server name in string format.
Filters the results by a specified image status. For example,
ACTIVE.
&limitMarkerReqParameter;
Filters the results by a specified image type. For example,
BASE, SERVER, or ALL.
'>
One or more security groups. Specify the name of the security group in
the name attribute. If you omit this attribute, the server
is created in the default security group.
Configuration information or scripts to use upon launch. Must be Base64
encoded.
The availability zone in which
to launch the server.
server.The image reference for the desired image
for your server instance.
Specify as an ID or full URL.
The flavor reference for the desired flavor
for your server instance.
Specify as an ID or full URL.
A networks object. By default,
the server instance is provisioned with all
isolated networks for the tenant.
Optionally, you can create one or more NICs
on the server.
To provision the server instance with a NIC
for a network, specify the UUID of the network
in the uuid attribute in a
networks object.
To provision the server instance with a NIC
for an already existing port, specify the
port-id in the port attribute in
a networks object.
You can specify multiple NICs on the server.
To provision the server instance with a NIC
for a network, specify the UUID of the network
in the uuid attribute in a
networks object. Required if you
omit the port attribute.
To provision the server instance with a NIC
for an already existing port, specify the
port-id in the port attribute in
a networks object. The port
status must be DOWN. Required if
you omit the uuid attribute.
A fixed IPv4 address for the NIC. Valid with
a neutron or
nova-networks network.
The server name.Metadata key and value pairs. The maximum
size of the metadata key and value is 255
bytes each.
File path and contents (text only) to inject
into the server at launch. The maximum size of
the file path data is 255 bytes. The maximum
limit refers to the number of bytes in the
decoded data and not the number of characters
in the encoded data.
Enables booting the server from a volume when additional parameters are
given. If specified, the volume status must be available,
and the volume attach_status in the OpenStack Block Storage
database must be detached.
Describes a path to the device for the volume that you want to use to
boot the server.
The source type for the volume. A valid value is blank,
snapshot, volume, or image.
Defines where the volume comes from. A valid value is local
or volume.
To delete the boot volume when the server stops, specify
true. Otherwise, specify false.
Specifies the guest server disk file system format, such as
ephemeral or swap.
The boot order of the device. Use -1 for the boot volume.
Use 0 for an attached volume.
Enables metadata injection in a server through a configuration drive.
Specify true to enable a configuration drive. Otherwise,
specify false.
Key pair name.
The dictionary of data to send to the scheduler.
Alternatively, you can specify OS-SCH-HNT:scheduler_hints
as the string.
'>
Required if you define a block device mapping.
The image reference as an ID or full URL for the image for your server
instance.
'>
Specify the rebuild action in the request body.
'>
The server name.
'>
The administrative password for the server.
'>
Metadata key and value pairs. The maximum size for each metadata key and
value pair is 255 bytes.
'>
File path and contents (text only) to inject into the server at
launch. The maximum size of the file path data is 255 bytes. The
maximum limit refers to the number of bytes in the decoded data
and not the number of characters in the encoded data.
'>
Indicates whether the server is rebuilt with the preservation of the
ephemeral partition (true).
'>
A time/date stamp for when the server last
changed status.
The UUID for the image.The UUID for the specific flavor, which is a combination
of memory, disk size, and CPUs.
Name of the server as a string. Can be queried with regular expressions.
The regular expression ?name=bob returns both bob and bobb.
If you must match on only bob, you can use a regular expression that
matches the syntax of the underlying database server that is implemented
for Compute, such as MySQL or PostgreSQL.
Value of the status of the server so that
you can filter on "ACTIVE" for
example.
Name of the host as a
string.
'>
A server object.The administrative password for the server.The server ID.Server links.
'>
The tenant ID in a multi-tenancy cloud.
'>
The ID of the snapshot.
'>
Filters the results by a specified server status. For example,
ACTIVE.
'>
The flavor ID.
'>
The keypair name.
'>
The user ID of the user who runs the operation.
'>
The aggregate ID.
'>
The cell ID.
'>
The agent build ID.
'>
The name of the DNS entry.
'>
The IP address.
'>
The ID of the floating IP address.
'>
The ID of the instance.
'>
The ID of the network.
'>
The network label, such as public or private.
'>
The name of the host.
'>
The ID of the hypervisor.
'>
The ID of the quota class.
'>
The ID of the security group.
'>
The certificate ID.
'>
The extra spec key for the flavor.
'>
The UUID for the server.
'>
The ID for the console.
'>
The metadata key.
'>
Filters the results by a specified image name in URL format.Filters the results by a specified flavor name in URL format.Filters the results by a specified server name in string format.
&limitMarkerReqParameter;
Filters the results by a specified server status. For example,
ACTIVE.
Filters the results by a specified host name in string format.
Sorts by the requested server attribute. Default is
created. You can specify multiple pairs of sort key and
sort direction query parameters. If you omit the sort direction in a
pair, the API uses the natural sorting direction of the server attribute
that is provided as the sort_key.
Sort direction. A valid value is asc (ascending) or
desc (descending). Default is desc. You can
specify multiple pairs of sort key and sort direction query parameters. If
you omit the sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the
sort_key.
'>
Sorts by the requested server attribute. Default is
created. You can specify multiple pairs of sort key and
sort direction query parameters. If you omit the sort direction in a
pair, the API uses the natural sorting direction of the server attribute
that is provided as the sort_key.
Sort direction. A valid value is asc (ascending) or
desc (descending). Default is desc. You can
specify multiple pairs of sort key and sort direction query parameters. If
you omit the sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the
sort_key.
'>
Indicates whether the server is locked (true) or unlocked
(false).
'>
The addresses for the server. If osapi_hide_server_address_states is set,
addresses information is hidden for any server in the specified state. By default,
servers in BUILDING state hide their addresses information.
'>
The name to associate with the keypair.
'>
The agent ID.
'>
Registered DNS domain published by the DNS
drivers.
'>
Registered DNS domain published by the DNS
drivers.
'>
Registered DNS domain published by the DNS
drivers.
'>
Registered DNS domain published by the DNS
drivers.
'>
Registered DNS domain published by the DNS
drivers.
'>
Registered DNS domain published by the DNS
drivers.
'>
The unique identifier associated with allocated floating IP address.
'>
The server group ID.
'>
The server group ID.
'>
Filters the results by a specified minimum disk space in GB.Filters the results by a specified minimum RAM in MB.
&limitMarkerReqParameter;'>
Integer value for the minimum disk space in GB.The flavor ID.The flavor name.Amount of RAM.Number of VCPUs.
'>
Integer value for the minimum disk space in GB.The flavor ID.Flavor links.The flavor name.Amount of RAM.Number of VCPUs.
'>
A
quota_set object.
The
number of instance cores allowed for each
tenant.
The
number of fixed IP addresses allowed for each
tenant. Must be equal to or greater than the
number of allowed instances.
The
number of floating IP addresses allowed for
each tenant.
The
ID for the quota set.
The
number of bytes of content allowed for each
injected file.
The
number of bytes allowed for each injected file
path.
The
number of injected files allowed for each
tenant.
The
number of instances allowed for each
tenant.
The
number of key pairs allowed for each
user.
The
number of metadata items allowed for each
instance.
The
amount of instance RAM in megabytes allowed
for each tenant.
The
number of rules allowed for each security
group.
The
number of security groups allowed for each
tenant.
The number of server groups allowed
for each tenant.
The number of members allowed for each
server group.
'>
A
quota_set object.
The
number of instance cores allowed for each
tenant.
The
number of fixed IP addresses allowed for each
tenant. Must be equal to or greater than the
number of allowed instances.
The
number of floating IP addresses allowed for
each tenant.
The
ID for the quota set.
The
number of bytes of content allowed for each
injected file.
The
number of bytes allowed for each injected file
path.
The
number of injected files allowed for each
tenant.
The
number of instances allowed for each
tenant.
The
number of key pairs allowed for each
user.
The
number of metadata items allowed for each
instance.
The
amount of instance RAM in megabytes allowed
for each tenant.
The
number of rules allowed for each security
group.
The
number of security groups allowed for each
tenant.
The number of server groups allowed
for each tenant.
The number of members allowed for each
server group.
'>
Specify the shelve action in the request body.
'>
Specify the shelveOffload
action in the request body.
'>
Specify the unshelve action in the request body.
'>
Security groups object.Security group description.The security group ID.The security group name.A rules object.
'>
A server_groups object.The ID for the server group.The name of the server group.A list of policies associated with the server group.A list of members in the server group.Associated metadata key-and-value pairs.
'>
Returns a unique identifier to provide tracking for the request. The
request ID associated with the request appears in the log lines for that
request. By default, the middleware configuration ensures the request ID
appears in the log files.
'>
Security groups object.Security group description.The security group ID.The security group name.A rules object.The tenant.
'>
Security groups object.
'>
Security group object.
'>
Security group description.The security group ID.The security group name.A security group rules object.The tenant.
'>
A virtual_interfaces object.The ID of the virtual interface.The MAC address.The ID of the virtual network.
'>
The date and time when the image last changed status.
Use this query parameter to check for changes since a previous request
rather than re-downloading and re-parsing the full status at each polling
interval. If data has changed, the call returns only the items changed
since the specified time. If data has not changed since the
changes-since time, the call returns an empty list.
To enable you to keep track of changes, this filter also displays images
that were deleted if the changes-since value specifies a date
in the last 30 days. Items deleted more than 30 days ago might be
returned, but it is not guaranteed.
The date and time stamp format is ISO 8601:
CCYY-MM-DDThh:mm:ss±hh:mm
The ±hh:mm value, if included, returns the time zone as an
offset from UTC.
For example, 2015-08-27T09:49:58-05:00.If you omit the time zone, the UTC time zone is assumed.Name of the server in URL
format.
Name of the image as a
string.
Value of the image statuses.
For example, you can filter on ACTIVE.
Value of the type of image, such as snapshot
or backup.
'>
The host name.
'>
The service name.
'>
The reason the service was disabled.
'>
Set to true to force down the service. Set to
false to unset a forced down service.
'>
If the service is forced down, this value is true.
'>
The service ID.
'>
The service state, which is up or down.
'>
The service status, which is enabled or
disabled.
'>
The availability zone of the host.
'>
A service object.
'>
A services object.
'>